Class LocalParticipant

constructor

• new LocalParticipant(owned_info: OwnedParticipant): LocalParticipant

  Parameters

  • owned_info: OwnedParticipant

  Returns LocalParticipant

trackPublications

editChatMessage

• editChatMessage(
      editText: string,
      originalMessage: ChatMessage,
      destinationIdentities?: string[],
      senderIdentity?: string,
  ): Promise<ChatMessage>
  Experimental

  Parameters

  • editText: string
  • originalMessage: ChatMessage
  • OptionaldestinationIdentities: string[]
  • OptionalsenderIdentity: string

  Returns Promise<ChatMessage>

handleRpcMethodInvocation

• handleRpcMethodInvocation(
      invocationId: bigint,
      method: string,
      requestId: string,
      callerIdentity: string,
      payload: string,
      responseTimeout: number,
  ): Promise<void>
  Internal

  Parameters

  • invocationId: bigint
  • method: string
  • requestId: string
  • callerIdentity: string
  • payload: string
  • responseTimeout: number

  Returns Promise<void>

performRpc

• performRpc(params: PerformRpcParams): Promise<string>

  Initiate an RPC call to a remote participant.

  Parameters

  • params: PerformRpcParams

    Parameters for initiating the RPC call, see PerformRpcParams

  Returns Promise<string>

  A promise that resolves with the response payload or rejects with an error.

  Throws

  Error on failure. Details in message.

publishData

• publishData(data: Uint8Array, options: DataPublishOptions): Promise<void>

  Parameters

  • data: Uint8Array
  • options: DataPublishOptions

  Returns Promise<void>

publishDtmf

• publishDtmf(code: number, digit: string): Promise<void>

  Parameters

  • code: number
  • digit: string

  Returns Promise<void>

publishTrack

• publishTrack(
      track: LocalTrack,
      options: TrackPublishOptions,
  ): Promise<LocalTrackPublication>

  Parameters

  • track: LocalTrack
  • options: TrackPublishOptions

  Returns Promise<LocalTrackPublication>

publishTranscription

• publishTranscription(transcription: Transcription): Promise<void>

  Parameters

  • transcription: Transcription

  Returns Promise<void>

registerRpcMethod

• registerRpcMethod(
      method: string,
      handler: (data: RpcInvocationData) => Promise<string>,
  ): void

  Establishes the participant as a receiver for calls of the specified RPC method. Will overwrite any existing callback for the same method.

  Parameters

  • method: string

    The name of the indicated RPC method
  • handler: (data: RpcInvocationData) => Promise<string>

    Will be invoked when an RPC request for this method is received

  Returns void

  A promise that resolves when the method is successfully registered

  Example

  room.localParticipant?.registerRpcMethod(
    'greet',
    async (data: RpcInvocationData) => {
      console.log(`Received greeting from ${data.callerIdentity}: ${data.payload}`);
      return `Hello, ${data.callerIdentity}!`;
    }
  );
  Copy

  See RpcInvocationData for more details on invocation params.

  The handler should return a Promise that resolves to a string. If unable to respond within responseTimeout, the request will result in an error on the caller's side.

  You may throw errors of type RpcError with a string message in the handler, and they will be received on the caller's side with the message intact. Other errors thrown in your handler will not be transmitted as-is, and will instead arrive to the caller as 1500 ("Application Error").

sendChatMessage

• sendChatMessage(
      text: string,
      destinationIdentities?: string[],
      senderIdentity?: string,
  ): Promise<ChatMessage>

  Sends a chat message to participants in the room

  Parameters

  • text: string

    The text content of the chat message.
  • OptionaldestinationIdentities: string[]

    An optional array of recipient identities to whom the message will be sent. If omitted, the message is broadcast to all participants.
  • OptionalsenderIdentity: string

    An optional identity of the sender. If omitted, the default sender identity is used.

  Returns Promise<ChatMessage>

sendFile

• sendFile(path: PathLike, options?: ByteStreamOptions): Promise<void>

  Sends a file provided as PathLike to specified recipients

  Parameters

  • path: PathLike
  • Optionaloptions: ByteStreamOptions

  Returns Promise<void>

sendText

• sendText(
      text: string,
      options?: {
          attributes?: Record<string, string>;
          destinationIdentities?: string[];
          streamId?: string;
          topic?: string;
      },
  ): Promise<BaseStreamInfo>

  Parameters

  • text: string
  • Optionaloptions: {
        attributes?: Record<string, string>;
        destinationIdentities?: string[];
        streamId?: string;
        topic?: string;
    }

  Returns Promise<BaseStreamInfo>

setAttributes

• setAttributes(attributes: Record<string, string>): Promise<void>

  Parameters

  • attributes: Record<string, string>

  Returns Promise<void>

streamBytes

• streamBytes(
      options?: {
          attributes?: Record<string, string>;
          destinationIdentities?: string[];
          mimeType?: string;
          name?: string;
          streamId?: string;
          topic?: string;
          totalSize?: number;
      },
  ): Promise<ByteStreamWriter>

  Parameters

  • Optionaloptions: {
        attributes?: Record<string, string>;
        destinationIdentities?: string[];
        mimeType?: string;
        name?: string;
        streamId?: string;
        topic?: string;
        totalSize?: number;
    }

  Returns Promise<ByteStreamWriter>

streamText

• streamText(
      options?: {
          attributes?: Record<string, string>;
          destinationIdentities?: string[];
          senderIdentity?: string;
          streamId?: string;
          topic?: string;
      },
  ): Promise<TextStreamWriter>

  Returns a StreamWriter instance that allows to write individual chunks of text to a stream. Well suited for TTS and/or streaming LLM output. If you want to simply send a text then use sendText() instead

  Parameters

  • Optionaloptions: {
        attributes?: Record<string, string>;
        destinationIdentities?: string[];
        senderIdentity?: string;
        streamId?: string;
        topic?: string;
    }

  Returns Promise<TextStreamWriter>

unpublishTrack

• unpublishTrack(trackSid: string, stopOnUnpublish?: boolean): Promise<void>

  Parameters

  • trackSid: string
  • OptionalstopOnUnpublish: boolean

  Returns Promise<void>

unregisterRpcMethod

• unregisterRpcMethod(method: string): void

  Unregisters a previously registered RPC method.

  Parameters

  • method: string

    The name of the RPC method to unregister

  Returns void

updateMetadata

• updateMetadata(metadata: string): Promise<void>

  Parameters

  • metadata: string

  Returns Promise<void>

updateName

• updateName(name: string): Promise<void>

  Parameters

  • name: string

  Returns Promise<void>