• Preparing search index...
  • The search index is not available
@urth/metatell-sdk - v0.0.24
  • @urth/metatell-sdk
  • subpaths/voice
  • onSpeaking

Function onSpeaking

  • onSpeaking(fn): Unsubscribe
  • Subscribe to changes in the current user's speaking state.

    Parameters

    • fn: ((event) => void)

      Handler that receives the speaking event.

        • (event): void
        • Parameters

          • event: SpeakingEvent

          Returns void

    Returns Unsubscribe

    A function that cancels the subscription. Call it on teardown.

    • Defined in packages/core/subpaths/voice/index.ts:48

Settings

Member Visibility

Theme

  • subpaths
    • auth
      • index.ts
        • InvalidClientIdError
        • NotAuthenticatedError
        • PluginApiClientNotFoundError
        • PluginTokenExchangeError
        • getPluginApiToken
    • chat
      • index.ts
        • Unsubscribe
        • ChatMessage
        • Mention
        • SendOptions
        • onMessage
        • parseMentions
        • reply
        • send
    • emote
      • index.ts
        • Unsubscribe
        • EmoteEvent
        • onEmote
        • trigger
    • events
      • index.ts
        • ChatMessage
        • EmoteEvent
        • GazeInfo
        • Mention
        • PointerEvent
        • RaycastHit
        • RemoteUser
        • SpeakingEvent
        • TransformUpdate
        • Unsubscribe
        • UserProfile
        • Vec3
        • ChatSendRequest
        • ChatSendResult
        • EmoteTriggerRequest
        • EventBus
        • EventMap
        • ObjectOpResult
        • ObjectTransform
        • RaycastRequest
        • RaycastResult
        • RoomObject
        • SettableProps
        • TriggerFiredEvent
        • TriggerInfo
        • TriggerOpResult
        • EntitySpec
        • ExecutionSide
        • ObjectErrorCode
        • ObjectOpRequest
        • ObjectType
        • TriggerErrorCode
        • TriggerOpRequest
        • TriggerPhase
        • TriggerType
        • createBus
        • getBus
        • off
        • on
        • once
    • input
      • index.ts
        • Unsubscribe
        • GazeInfo
        • PointerEvent
        • RaycastHit
        • RaycastOptions
        • Vec3
        • onGaze
        • onHover
        • onPointerDown
        • onPointerMove
        • onPointerUp
        • raycast
    • user
      • index.ts
        • UserProfile
        • Unsubscribe
        • changeAvatar
        • getId
        • getProfile
        • onProfileUpdate
        • setMovementEnabled
    • users
      • index.ts
        • Unsubscribe
        • RemoteUser
        • SpeakingEvent
        • TransformUpdate
        • get
        • list
        • onJoin
        • onLeave
        • onSpeaking
        • onTransform
        • onUpdate
    • voice
      • index.ts
        • SpeakingEvent
        • Unsubscribe
        • getLocalLevel
        • onSpeaking
  • types
    • property.ts
      • DeviceData
      • EulerData
      • QuaternionData
      • TransformData
      • Vector3Data
      • CameraData
      • EulerOrder
      • VEQData
      • WaypointData
      • onChangeCameraFunction
      • onChangeDeviceFunction
      • onScreenSharingFunction
      • onSpeechEndFunction
      • onUpdateTransformFunction
      • onUpdateVEQFunction
  • index.ts
    • metrics
    • Avatar
    • Camera
    • Mic
    • Screen
    • user
    • getWaypoints
    • warpToWaypoint