Dev Center
Interactive Live Streaming Premium
Agora.io Community
English
search-icon
Agora React Native API Reference
Overview RtcEngine RtcEngineEvents RtcChannel RtcChannelEvents Warning Codes Error Codes

The RtcChannel class.

Hierarchy

  • RtcChannel

Implements

  • RtcChannelInterface

Index

Properties

Methods

Properties

Readonly channelId

channelId: string

The ID of RtcChannel

Methods

addInjectStreamUrl

  • Injects an online media stream to live interactive streaming.

    If this method call succeeds, the server pulls the voice or video stream and injects it into a live channel. This applies to scenarios where all audience members in the channel can watch a live show and interact with each other.

    Calling this method triggers the following callbacks:

    • The local client:
      • StreamInjectedStatus, with the state of injecting the media stream.
      • UserJoined(uid: 666), if the method call succeeds and the online media stream is injected into the channel.
    • The remote client:
      • UserJoined(uid: 666), if the method call succeeds and the online media stream is injected into the channel.

    Warning

    Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it.

    Note

    • Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
    • This method can only be called by a host in a LiveBroadcasting channel.

    Parameters

    • url: string

      The URL address to be added to the ongoing live interactive streaming. Valid protocols are RTMP, HLS, and FLV.

      • Supported FLV audio codec type: AAC.
      • Supported FLV video codec type: H264 (AVC).
    • config: LiveInjectStreamConfig

      The LiveInjectStreamConfig object, which contains the configuration information for the added voice or video stream.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 2(InvalidArgument): The injected URL does not exist. Call this method again to inject the stream and ensure that the URL is valid.
      • 3(NotReady): The user is not in the channel.
      • 4(NotSupported): The channel profile is not LiveBroadcasting. Call the setChannelProfile method and set the channel profile to LiveBroadcasting before calling this method.
      • 7(NotInitialized): The SDK is not initialized. Initialize the RtcEngine instance before calling this method.

addListener

  • addListener<EventType>(event: EventType, listener: RtcChannelEvents[EventType]): Subscription

addPublishStreamUrl

  • addPublishStreamUrl(url: string, transcodingEnabled: boolean): Promise<void>

  • Publishes the local stream to a specified CDN streaming URL.

    After calling this method, you can push media streams in RTMP or RTMPS protocol to the CDN.

    This method call triggers the RtmpStreamingStateChanged callback on the local client to report the state of adding a local stream to the CDN.

    Note

    • Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
    • Ensure that the user joins a channel before calling this method.
    • This method can only be called by a host in a LiveBroadcasting channel.
    • This method adds only one CDN streaming URL each time it is called.
    • Agora supports pushing media streams in RTMPS protocol to the CDN only when you enable transcoding.

    Parameters

    • url: string

      The CDN streaming URL in the RTMP or RTMPS format. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters, such as Chinese language characters.

    • transcodingEnabled: boolean

      Whether to enable transcoding. If you set this parameter as true, ensure that you call the setLiveTranscoding method before this method.

      • true: Enable transcoding. To transcode the audio or video streams when publishing them to CDN live, often used for combining the audio and video streams of multiple hosts in CDN live.
      • false: Disable transcoding.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 2(InvalidArgument): Invalid parameter, usually because the URL address is null or the string length is 0.
      • 7(NotInitialized): You have not initialized RtcEngine when publishing the stream.

adjustUserPlaybackSignalVolume

  • adjustUserPlaybackSignalVolume(uid: number, volume: number): Promise<void>

  • Adjusts the playback volume of a specified remote user.

    You can call this method as many times as necessary to adjust the playback volume of different remote users, or to repeatedly adjust the playback volume of the same remote user.

    Note

    • Call this method after joining a channel.
    • The playback volume here refers to the mixed volume of a specified remote user.
    • This method can only adjust the playback volume of one specified remote user at a time. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.

    Parameters

    • uid: number

      ID of the remote user.

    • volume: number

      The playback volume of the specified remote user. The value ranges from 0 to 100:

      • 0: Mute.
      • 100: The original volume.

    Returns Promise<void>

createDataStream

  • createDataStream(reliable: boolean, ordered: boolean): Promise<number>

  • Creates a data stream.

    Each user can create up to five data streams during the life cycle of the RtcChannel instance.

    Note

    Set both the reliable and ordered parameters to true or false. Do not set one as true and the other as false.

    Parameters

    • reliable: boolean

      Sets whether the recipients are guaranteed to receive the data stream from the sender within five seconds.

      • true: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the StreamMessageError callback and returns an error code.
      • false: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream.
    • ordered: boolean

      Determines whether the recipients receive the data stream in the sent order.

      • true: The recipients receive the data in the sent order.
      • false: The recipients do not receive the data in the sent order.

    Returns Promise<number>

    • Returns the stream ID, if the method call is successful.
    • Error codes: Failure. The error code is related to the integer displayed in Error Codes.

destroy

  • destroy(): Promise<void>

  • Destroys the RtcChannel instance.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 7(NotInitialized): The RtcChannel instance is not initialized before calling this method.

enableEncryption

  • Enables/Disables the built-in encryption.

    since

    v3.1.2.

    In scenarios requiring high security, Agora recommends calling enableEncryption to enable the built-in encryption before joining a channel.

    All users in the same channel must use the same encryption mode and encryption key. Once all users leave the channel, the encryption key of this channel is automatically cleared.

    Note

    • If you enable the built-in encryption, you cannot use the RTMP or RTMPS streaming function.
    • Agora supports four encryption modes. If you choose an encryption mode (excepting SM4128ECB mode), you need to add an external encryption library when integrating the SDK. For details, see the advanced guide Channel Encryption.

    Parameters

    • enabled: boolean

      Whether to enable the built-in encryption.

      • true: Enable the built-in encryption.
      • false: Disable the built-in encryption.
    • config: EncryptionConfig

      Configurations of built-in encryption schemas. See EncryptionConfig.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 2(InvalidArgument): An invalid parameter is used. Set the parameter with a valid value.
      • 4(NotSupported): The encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library.
      • 7(NotInitialized): The SDK is not initialized. Initialize the RtcEngine instance before calling this method.

getCallId

  • getCallId(): Promise<string>

  • Gets the current call ID.

    Returns Promise<string>

    • The current call ID, if the method call succeeds.
    • The empty string "", if the method call fails.

getConnectionState

joinChannel

  • joinChannel(token: string | undefined | null, optionalInfo: string | undefined | null, optionalUid: number, options: ChannelMediaOptions): Promise<void>

  • Joins the channel with a user ID.

    Note

    • If you are already in a channel, you cannot rejoin it with the same UID.
    • We recommend using different UIDs for different channels.
    • If you want to join the same channel from different devices, ensure that the UIDs in all devices are different.
    • Ensure that the app ID you use to generate the token is the same with the app ID used when creating the RtcEngine instance.

    Once the user joins the channel (switches to another channel), the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. If you do not want to subscribe to a specified stream or all remote streams, call the mute methods accordingly.

    Parameters

    • token: string | undefined | null

      The token generated at your server.

      • In situations not requiring high security: You can use the temporary token generated at Console. For details, see Get a temporary token.
      • In situations requiring high security: Set it as the token generated at your server. For details, see Generate a token.
    • optionalInfo: string | undefined | null

      Additional information about the channel. This parameter can be set as null. Other users in the channel do not receive this information.

    • optionalUid: number

      The user ID. A 32-bit unsigned integer with a value ranging from 1 to (232-1). This parameter must be unique. If uid is not assigned (or set as 0), the SDK assigns a uid and reports it in the JoinChannelSuccess callback. The app must maintain this user ID.

    • options: ChannelMediaOptions

      The channel media options.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 2(InvalidArgument): The parameter is invalid.
      • 3(NotReady): The SDK fails to be initialized. You can try re-initializing the SDK.
      • 5(Refused): The request is rejected. Possible reasons:
        • You have created an RtcChannel object with the same channel name.
        • You have joined and published a stream in a channel created by the RtcChannel object.
      • 7(NotInitialized): The SDK is not initialized.

joinChannelWithUserAccount

  • joinChannelWithUserAccount(token: string | undefined | null, userAccount: string, options: ChannelMediaOptions): Promise<void>

  • Joins a channel with the user account.

    Note

    • If you are already in a channel, you cannot rejoin it with the same user account.
    • We recommend using different user accounts for different channels.
    • If you want to join the same channel from different devices, ensure that the user accounts in all devices are different.
    • Ensure that the app ID you use to generate the token is the same with the app ID used when creating the RtcEngine instance.

    Once the user joins the channel (switches to another channel), the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. If you do not want to subscribe to a specified stream or all remote streams, call the mute methods accordingly.

    Parameters

    • token: string | undefined | null

      The token generated at your server.

      • In situations not requiring high security: You can use the temporary token generated at Console. For details, see Get a temporary token.
      • In situations requiring high security: Set it as the token generated at your server. For details, see Generate a token.
    • userAccount: string

      The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null.

      • All lowercase English letters: a to z.
      • All uppercase English letters: A to Z.
      • All numeric characters: 0 to 9.
      • The space character.
      • Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
    • options: ChannelMediaOptions

      The channel media options.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 2(InvalidArgument): The parameter is invalid.
      • 3(NotReady): The SDK fails to be initialized. You can try re-initializing the SDK.
      • 5(Refused): The request is rejected.

leaveChannel

  • leaveChannel(): Promise<void>

  • Leaves the current channel.

    A successful call of this method triggers the following callbacks:

    • The local client: LeaveChannel.
    • The remote client: UserOffline, if the user leaving the channel is in a Communication channel, or is a host in a LiveBroadcasting channel.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 1(Failed): A general error occurs (no specified reason).
      • 2(InvalidArgument): The parameter is invalid.
      • 7(NotInitialized): The SDK is not initialized.

muteAllRemoteAudioStreams

  • muteAllRemoteAudioStreams(muted: boolean): Promise<void>

  • Stops/Resumes receiving all remote audio streams.

    Parameters

    • muted: boolean

      Determines whether to receive/stop receiving all remote audio streams:

      • true: Stop receiving all remote audio streams.
      • false: (Default) Receive all remote audio streams.

    Returns Promise<void>

muteAllRemoteVideoStreams

  • muteAllRemoteVideoStreams(muted: boolean): Promise<void>

  • Stops/Resumes receiving all remote video streams.

    Parameters

    • muted: boolean

      Determines whether to receive/stop receiving all remote video streams:

      • true: Stop receiving all remote video streams.
      • false: (Default) Receive all remote video streams.

    Returns Promise<void>

muteRemoteAudioStream

  • muteRemoteAudioStream(uid: number, muted: boolean): Promise<void>

  • Stops/Resumes receiving the audio stream of the specified user.

    Parameters

    • uid: number

      ID of the remote user whose audio stream you want to mute.

    • muted: boolean

      Determines whether to receive/stop receiving the audio stream of the specified user:

      • true: Stop receiving the audio stream of the user.
      • false: (Default) Receive the audio stream of the user.

    Returns Promise<void>

muteRemoteVideoStream

  • muteRemoteVideoStream(uid: number, muted: boolean): Promise<void>

  • Stops/Resumes receiving the video stream of the specified user.

    Parameters

    • uid: number

      ID of the remote user whose video stream you want to mute.

    • muted: boolean

      Determines whether to receive/stop receiving the video stream of the specified user:

      • true: Stop receiving the video stream of the user.
      • false: (Default) Receive the video stream of the user.

    Returns Promise<void>

publish

  • publish(): Promise<void>

  • Publishes the local stream to the channel. You must keep the following restrictions in mind when calling this method. Otherwise, the SDK returns the Refused(-5):

    • This method publishes one stream only to the channel corresponding to the current RtcChannel instance.
    • In a LiveBroadcasting channel, only a host can call this method. To switch the client role, call setClientRole of the current RtcChannel instance.
    • You can publish a stream to only one channel at a time. For details, see the advanced guide Join Multiple Channels.

    Returns Promise<void>

registerMediaMetadataObserver

  • registerMediaMetadataObserver(): Promise<void>

  • Registers the metadata observer.

    A successful call of this method triggers the setMaxMetadataSize method.

    This method enables you to add synchronized metadata in the video stream for more diversified live streaming interactions, such as sending shopping links, digital coupons, and online quizzes.

    Note

    Returns Promise<void>

removeAllListeners

  • removeAllListeners<EventType>(event?: EventType): void

removeInjectStreamUrl

  • removeInjectStreamUrl(url: string): Promise<void>

  • Removes the injected online media stream from a LiveBroadcasting channel.

    This method removes the URL address added by addInjectStreamUrl.

    If you successfully remove the URL address from the live interactive streaming, the SDK triggers the UserJoined callback, with the stream uid of 666.

    Warning

    Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it.

    Parameters

    • url: string

      The URL address to be removed.

    Returns Promise<void>

removeListener

  • removeListener<EventType>(event: EventType, listener: RtcChannelEvents[EventType]): void

  • Removes the RtcChannelEvents handler.

    For callback events that you only want to listen for once, call this method to remove the specific RtcEngineEvents objects after you have received them.

    Type parameters

    Parameters

    • event: EventType

      The event type.

    • listener: RtcChannelEvents[EventType]

      The RtcChannelEvents handler.

    Returns void

removePublishStreamUrl

  • removePublishStreamUrl(url: string): Promise<void>

  • Removes an RTMP or RTMPS stream from the CDN.

    This method removes the CDN streaming URL (added by addPublishStreamUrl) from a CDN live stream. The SDK reports the result of this method call in the RtmpStreamingStateChanged callback.

    Note

    • Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
    • This method can only be called by a host in a LiveBroadcasting channel.
    • This method removes only one CDN streaming URL each time it is called.

    Parameters

    • url: string

      The CDN streaming URL to be removed. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters, such as Chinese language characters.

    Returns Promise<void>

renewToken

  • renewToken(token: string): Promise<void>

  • Renews the token when the current token expires.

    In the following situations, the SDK decides that the current token has expired:

    You should get a new token from your server and call this method to renew it. Failure to do so results in the SDK disconnecting from the Agora server.

    Parameters

    • token: string

      The new token.

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 1(Failed): A general error occurs (no specified reason).
      • 2(InvalidArgument): The parameter is invalid.
      • 7(NotInitialized): The SDK is not initialized.

sendMetadata

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

  • Sends the metadata.

    Parameters

    • metadata: string

      The metadata to be sent.

    Returns Promise<void>

sendStreamMessage

  • sendStreamMessage(streamId: number, message: string): Promise<void>

  • Sends the data stream message.

    The SDK has the following restrictions on this method:

    • Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.
    • Each client can send up to 6 KB of data per second.
    • Each user can have up to five data channels simultaneously.

    A successful call of this method triggers the StreamMessage callback on the remote client, from which the remote user gets the stream message.

    A failed call of this method triggers the StreamMessageError callback on the remote client.

    Parameters

    • streamId: number

      ID of the sent data stream returned by the createDataStream method.

    • message: string

      The message data.

    Returns Promise<void>

setClientRole

  • Sets the role of a user in live interactive streaming.

    You can call this method either before or after joining the channel to set the user role as audience or host. If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:

    Note

    • This method applies to the LiveBroadcasting profile only (when the profile parameter in setChannelProfile is set as LiveBroadcasting).
    • As of v3.2.0, this method can set the user level in addition to the user role.
      • The user role determines the permissions that the SDK grants to a user, such as permission to send local streams, receive remote streams, and push streams to a CDN address.
      • The user level determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience can choose to receive remote streams with low latency or ultra low latency. Levels affect prices.

    Parameters

    Returns Promise<void>

    • 0(NoError): Success.
    • Error codes: Failure.
      • 1(Failed): A general error occurs (no specified reason).
      • 2(InvalidArgument): The parameter is invalid.
      • 7(NotInitialized): The SDK is not initialized.

setDefaultMuteAllRemoteAudioStreams

  • setDefaultMuteAllRemoteAudioStreams(muted: boolean): Promise<void>

  • Sets whether to receive all remote audio streams by default.

    Parameters

    • muted: boolean

      Determines whether to receive/stop receiving all remote audio streams by default:

      • true: Stop receiving all remote audio streams by default.
      • false: (Default) Receive all remote audio streams by default.

    Returns Promise<void>

setDefaultMuteAllRemoteVideoStreams

  • setDefaultMuteAllRemoteVideoStreams(muted: boolean): Promise<void>

  • Sets whether to receive all remote video streams by default.

    Parameters

    • muted: boolean

      Determines whether to receive/stop receiving all remote video streams by default:

      • true: Stop receiving all remote video streams by default.
      • false: (Default) Receive all remote video streams by default.

    Returns Promise<void>

setEncryptionMode

  • Sets the built-in encryption mode.

    deprecated

    Deprecated as of v3.1.2. Use enableEncryption instead.

    The Agora SDK supports built-in encryption, which is set to aes-128-xts mode by default. Call this method to set the encryption mode to use other encryption modes. All users in the same channel must use the same encryption mode and password. Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.

    Note

    • Do not use this method for CDN streaming.
    • Before calling this method, ensure that you have called setEncryptionSecret to enable encryption.

    Parameters

    Returns Promise<void>

setEncryptionSecret

  • setEncryptionSecret(secret: string): Promise<void>

  • Enables built-in encryption with an encryption password before joining a channel.

    deprecated

    Deprecated as of v3.1.2. Use enableEncryption instead.

    All users in a channel must set the same encryption password. The encryption password is automatically cleared once a user leaves the channel. If the encryption password is not specified or set to empty, the encryption functionality is disabled.

    Note

    • For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.
    • Do not use this method for CDN live streaming.

    Parameters

    • secret: string

      The encryption password.

    Returns Promise<void>

setLiveTranscoding

  • Sets the video layout and audio settings for CDN live.

    The SDK triggers the TranscodingUpdated callback when you call this method to update the LiveTranscoding class. If you call this method to set the LiveTranscoding class for the first time, the SDK does not trigger the TranscodingUpdated callback.

    Note

    • Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in Push Streams to CDN.
    • Ensure that the user joins a channel before calling this method.
    • This method can only be called by a host in a LiveBroadcasting channel.
    • Ensure that you call this method before calling the addPublishStreamUrl method.
    • Agora supports pushing media streams in RTMPS protocol to the CDN only when you enable transcoding.

    Parameters

    • transcoding: LiveTranscoding

      Sets the CDN live audio/video transcoding settings.

    Returns Promise<void>

setMaxMetadataSize

  • setMaxMetadataSize(size: number): Promise<void>

  • Sets the maximum size of the metadata.

    Parameters

    • size: number

      Buffer size of the sent or received metadata.

    Returns Promise<void>

setRemoteDefaultVideoStreamType

  • setRemoteDefaultVideoStreamType(streamType: VideoStreamType): Promise<void>

  • Sets the default video-stream type of the remote video stream when the remote user sends dual streams.

    Parameters

    Returns Promise<void>

setRemoteUserPriority

  • setRemoteUserPriority(uid: number, userPriority: UserPriority): Promise<void>

  • Sets the priority of a remote user's media stream.

    Use this method with the setRemoteSubscribeFallbackOption method. If a remote video stream experiences the fallback, the SDK ensures the high-priority user gets the best possible stream quality.

    Note The Agora SDK supports setting userPriority as high for one user only.

    Parameters

    • uid: number

      The ID of the remote user.

    • userPriority: UserPriority

      The priority of the remote user.

    Returns Promise<void>

setRemoteVideoStreamType

  • setRemoteVideoStreamType(uid: number, streamType: VideoStreamType): Promise<void>

  • Sets the video stream type of the remote video stream when the remote user sends dual streams. This method allows the app to adjust the corresponding video-stream type based on the size of the video window to reduce the bandwidth and resources.

    • If the remote user enables the dual-stream mode by calling the enableDualStreamMode method, the SDK receives the high-video stream by default. You can use this method to switch to the low-video stream.
    • If dual-stream mode is not enabled, the SDK receives the high-stream video by default. By default, the aspect ratio of the low-video stream is the same as the high-video stream. Once the resolution of the high-video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream.

    Parameters

    • uid: number

      ID of the remote user sending the video stream.

    • streamType: VideoStreamType

      Sets the video-stream type.

    Returns Promise<void>

setRemoteVoicePosition

  • setRemoteVoicePosition(uid: number, pan: number, gain: number): Promise<void>

  • Sets the sound position of a remote user.

    When the local user calls this method to set the sound position of a remote user, the sound difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a real sense of space. This method applies to massively multiplayer online games, such as Battle Royale games.

    Note

    • For this method to work, enable stereo panning for remote users by calling the enableSoundPositionIndication method before joining a channel.
    • This method requires hardware support. For the best sound positioning, we recommend using a stereo headset.

    Parameters

    • uid: number

      The ID of the remote user.

    • pan: number

      The sound position of the remote user. The value ranges from -1.0 to 1.0:

      • 0.0: (default) The remote sound comes from the front.
      • -1.0: The remote sound comes from the left.
      • 1.0: The remote sound comes from the right.
    • gain: number

      Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). The smaller the value, the less the gain.

    Returns Promise<void>

startChannelMediaRelay

stopChannelMediaRelay

  • stopChannelMediaRelay(): Promise<void>

unpublish

  • unpublish(): Promise<void>

  • Stops publishing a stream to the channel.

    If you call this method in a channel where you are not publishing streams, the SDK returns Refused(-5).

    Returns Promise<void>

unregisterMediaMetadataObserver

  • unregisterMediaMetadataObserver(): Promise<void>

  • Unregisters the metadata observer.

    Returns Promise<void>

updateChannelMediaRelay

  • Updates the channels for media relay.

    After the channel media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method. After a successful method call, the SDK triggers the ChannelMediaRelayEvent callback with the UpdateDestinationChannel(7) state code.

    Note

    • Call this method after the startChannelMediaRelay method to update the destination channel.
    • This method supports adding at most four destination channels in the relay.

    Parameters

    Returns Promise<void>

Static create

  • Creates and gets an RtcChannel instance.

    To join more than one channel, call this method multiple times to create as many RtcChannel instances as needed, and call the joinChannel method of each created RtcChannel object.

    After joining multiple channels, you can simultaneously subscribe to streams of all the channels, but publish a stream in only one channel at one time.

    Parameters

    • channelId: string

      The unique channel name for the Agora RTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:

      • All lowercase English letters: a to z.
      • All uppercase English letters: A to Z.
      • All numeric characters: 0 to 9.
      • The space character.
      • Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".

      Note

      • This parameter does not have a default value. You must set it.
      • Do not set it as the empty string "". Otherwise, the SDK returns Refused(-5).

    Returns Promise<RtcChannel>

    • An RtcChannel instance, if the method call succeeds.
    • Null, if the method call fails.
    • Refused(-5), if you set channelId as the empty string "".

Static destroyAll

  • destroyAll(): void
score