文档中心





视频通话 (Legacy)

Console 官网社区技术支持





Agora React Native API Reference

概览 RtcEngine RtcEngineEvents RtcChannel RtcChannelEvents 警告码错误码

RtcChannel 类。

Hierarchy

RtcChannel

Implements

RtcChannelInterface

Index

Methods

addInjectStreamUrl

addInjectStreamUrl(url: string, config: LiveInjectStreamConfig): Promise<void>

输入在线媒体流。

该方法通过在服务端拉取视频流并发送到频道中，将正在播出的视频输入到正在进行的直播中。可主要应用于赛事直播、多人看视频互动等直播场景。

调用该方法后，SDK 会在本地触发 StreamInjectedStatus 回调，报告输入在线媒体流的状态；成功输入媒体流后，该音视频流会出现在频道中，频道内所有用户都会收到 UserJoined(uid: 666)。

Warning

客户端输入在线媒体流功能即将停服。如果你尚未集成该功能，Agora 建议你不要使用。详见《部分服务下架计划》。

Note
- 调用该方法前，请确保已开通旁路推流的功能，详见进阶功能《推流到 CDN》中的前提条件。
- 该方法仅适用于直播场景中的主播用户。
Parameters
- url: string
  添加到直播中的视频流 URL 地址，支持 RTMP， HLS， FLV 协议传输。
  - 支持的 FLV 音频编码格式：AAC。
  - 支持的 FLV 视频编码格式：H264 (AVC)。
- config: LiveInjectStreamConfig
  
  LiveInjectStreamConfig 类，外部输入的音视频流的配置。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 2(InvalidArgument): 输入的 URL 为空。请重新调用该方法，并确认输入的媒体流的 URL 是有效的
  - 3(NotReady)：用户没有加入频道。
  - 4(NotSupported): 频道非直播场景。请调用 setChannelProfile 并将频道设置为直播场景再调用该方法
  - 7(NotInitialized): SDK 尚未初始化。需在调用 API 之前已创建 RtcEngine 对象并完成初始化。

addListener

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

设置频道事件句柄。

设置后，你可以通过 RtcChannelEvents 回调监听对应频道内的事件、获取频道数据。

Type parameters
- EventType: keyof RtcChannelEvents
Parameters
- event: EventType
  
  事件类型。
- listener: RtcChannelEvents[EventType]
  
  RtcChannel 对象的事件回调。
Returns Subscription

addPublishStreamUrl

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

增加旁路推流地址。

调用该方法后，你可以向 CDN 推送 RTMP 或 RTMPS 协议的媒体流。SDK 会在本地触发 RtmpStreamingStateChanged 回调，报告增加旁路推流地址的状态。

Note
- 调用该方法前，请确保已开通旁路推流的功能，详见进阶功能《推流到 CDN》中的前提条件。
- 请确保在成功加入频道后才能调用该接口。
- 该方法仅适用直播场景。
- 该方法每次只能增加一路旁路推流地址。若需推送多路流，则需多次调用该方法。
- Agora 目前仅支持转码时向 CDN 推送 RTMPS 协议的媒体流。
Parameters
- url: string
  
  CDN 推流地址，格式为 RTMP。该字符长度不能超过 1024 字节。url 不支持中文等特殊字符。
- transcodingEnabled: boolean
  是否转码。如果设为 true，则需要在该方法前先调用 setLiveTranscoding 方法。
  - true：转码。转码是指在旁路推流时对音视频流进行转码处理后，再推送到其他 CDN 服务器。多适用于频道内有多个主播，需要进行混流、合图的场景。
  - false：不转码。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 2(InvalidArgument)：参数无效，一般是 URL 为空或是长度为 0 的字符串
  - 7(NotInitialized)：推流时未初始化引擎。

adjustUserPlaybackSignalVolume

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

调节本地播放的指定远端用户音量。

你可以多次调用该方法调节不同远端用户在本地播放的音量，或对某个远端用户在本地播放的音量调节多次。

Note
- 该方法要在加入频道后调用。
- 该方法调节的是本地播放的指定远端用户混音后的音量。
- 该方法每次只能调整一位远端用户在本地播放的音量。若需调整多位远端用户在本地播放的音量，则需多次调用该方法。
Parameters
- uid: number
  
  远端用户的 ID。
- volume: number
  播放音量，取值范围为 [0,100]。
  - 0：静音。
  - 100：原始音量。
Returns Promise<void>

createDataStream

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

创建数据流。

deprecated

该方法从 v3.3.0 起废弃，请改用 createDataStreamWithConfig。

该方法用于创建数据流。RtcChannel 生命周期内，每个用户最多只能创建 5 个数据流。

Note

请将 reliable 和 ordered 同时设置为 true 或 false，暂不支持交叉设置。

Parameters
- reliable: boolean
  设置是否保证接收方在 5 秒内收到数据消息：
  - true：接收方 5 秒内会收到发送方所发送的数据，否则会收到 StreamMessageError 回调并获得相应报错信息。
  - false：接收方不保证收到，就算数据丢失也不会报错。
- ordered: boolean
  设置接收方是否按发送方发送的顺序接收数据消息：
  - true：接收方会按照发送方发送的顺序收到数据包。
  - false：接收方不保证按照发送方发送的顺序收到数据包。
Returns Promise<number>
- 创建数据流成功则返回数据流 ID。
- < 0：创建数据流失败。如果返回的错误码是负数，对应错误代码和警告代码里的正整数。

createDataStreamWithConfig

createDataStreamWithConfig(config: DataStreamConfig): Promise<number>

创建数据流。

since

v3.3.1

该方法用于创建数据流。每个用户在每个频道内最多只能创建 5 个数据流。

该方法不支持数据可靠，接收方会丢弃超出发送时间 5 秒后的数据包。

Parameters
- config: DataStreamConfig
  
  数据流设置。详见 DataStreamConfig。
Returns Promise<number>
- 创建数据流成功则返回数据流 ID。
- < 0: 创建数据流失败。

destroy

destroy(): Promise<void>

销毁当前的 RtcChannel 对象。

Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 7(NotInitialized)：调用该方法前尚未初始化 RtcChannel 对象。

enableEncryption

enableEncryption(enabled: boolean, config: EncryptionConfig): Promise<void>

开启或关闭内置加密。
since
v3.1.2。

在安全要求较高的场景下，Agora 建议你在加入频道前，调用 enableEncryption 方法开启内置加密。

同一频道内所有用户必须使用相同的加密模式和密钥。一旦所有用户都离开频道，该频道的加密密钥会自动清除。

Note
- 如果开启了内置加密，则不能使用 RTMP/RTMPS 推流功能。
- Agora 支持 4 种加密模式。除 SM4128ECB 模式外，其他加密模式都需要在集成 SDK 时，额外添加加密库文件。详见《媒体流加密》。
Parameters
- enabled: boolean
  是否开启内置加密：
  - true: 开启内置加密。
  - false: 关闭内置加密。
- config: EncryptionConfig
  
  配置内置加密模式和密钥。详见 EncryptionConfig。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 2(InvalidArgument): 参数无效。
  - 4(NotSupported): 设置的加密模式不正确或加载外部加密库失败。需检查枚举值是否正确或重新加载外部加密库。
  - 7(NotInitialized): SDK 尚未初始化。需在调用 API 之前已创建 RtcEngine 对象并完成初始化。

getCallId

getCallId(): Promise<string>

获取当前的通话 ID。

Returns Promise<string>
- 方法调用成功，则返回当前的通话 ID。
- 方法调用失败，则返回空字符串 ""。

getConnectionState

getConnectionState(): Promise<ConnectionStateType>

获取网络连接状态。

Returns Promise<ConnectionStateType>

joinChannel

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

使用 UID 加入频道。

Note
- 该方法不支持相同的用户重复加入同一个频道。
- Agora 建议不同频道中使用不同的 UID。
- 如果想要从不同的设备同时接入同一个频道，请确保每个设备上使用的 UID 是不同的。
- 请确保用于生成 Token 的 App ID 和创建 RtcEngine 对象时用的 App ID 一致。
用户成功加入（切换）频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。
Parameters
- token: string | undefined | null
  
  在 App 服务器端生成的用于鉴权的 Token，详见从服务端生成 Token。
- optionalInfo: string | undefined | null
  
  开发者需加入的任何附加信息。一般可设置为空字符串，或频道相关信息。该信息不会传递给频道内的其他用户。
- optionalUid: number
  
  用户 ID，32 位无符号整数。建议设置范围：1 到 (2³²-1)，并保证唯一性。如果不指定（即设为 0），SDK 会自动分配一个，并在 JoinChannelSuccess 回调方法中返回，App 层必须记住该返回值并维护，SDK 不对该返回值进行维护。
- options: ChannelMediaOptions
  
  频道媒体设置选项。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 2(InvalidArgument): 参数无效。
  - 3(NotReady): SDK 初始化失败，请尝试重新初始化 SDK。
  - 5(Refused): 调用被拒绝。可能有如下两个原因：
    - 已经创建了一个同名的 RtcChannel 频道。
    - 已经通过 RtcChannel 加入了一个频道，并在该 RtcChannel 频道中发布了音视频流。
  - 7(NotInitialized): SDK 尚未初始化，就调用其 API。请确认在调用 API 之前已创建 RtcEngine 对象并完成初始化。

joinChannelWithUserAccount

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

使用 User Account 加入频道。

Note
- 该方法不支持相同的用户重复加入同一个频道。
- 我们建议不同频道中使用不同的 User Account。
- 如果想要从不同的设备同时接入同一个频道，请确保每个设备上使用的 User Account 是不同的。
- 请确保用于生成 Token 的 App ID 和创建 RtcEngine 对象时用的 App ID 一致。
用户成功加入（切换）频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。
Parameters
- token: string | undefined | null
  
  在 App 服务器端生成的用于鉴权的 Token，详见从服务端生成 Token。
- userAccount: string
  用户 User Account。该参数为必需，最大不超过 255 字节，不可为 null。请确保加入频道的 User Account 的唯一性。以下为支持的字符集范围（共 89 个字符）：
  - 26 个小写英文字母 a-z
  - 26 个大写英文字母 A-Z
  - 10 个数字 0-9
  - 空格
  - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
- options: ChannelMediaOptions
  
  频道媒体设置选项。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 2(InvalidArgument): 参数无效。
  - 3(NotReady): SDK 初始化失败，请尝试重新初始化 SDK。
  - 5(Refused): 调用被拒绝。

leaveChannel

leaveChannel(): Promise<void>

离开当前频道。

成功调用该方法离开频道后，会触发如下回调：
- 本地：LeaveChannel
- 远端：通信场景下的用户和直播场景下的主播离开频道后，触发 UserOffline。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 1(Failed): 一般性的错误（未明确归类）。
  - 2(InvalidArgument): 参数无效。
  - 7(NotInitialized): SDK 尚未初始化。

muteAllRemoteAudioStreams

muteAllRemoteAudioStreams(muted: boolean): Promise<void>

停止/恢复接收所有音频流。

Parameters
- muted: boolean
  设置是否停止接收所有远端音频流：
  - true：停止接收所有远端音频流。
  - false：继续接收所有远端音频流（默认）。
Returns Promise<void>

muteAllRemoteVideoStreams

muteAllRemoteVideoStreams(muted: boolean): Promise<void>

停止/恢复接收所有视频流。

Parameters
- muted: boolean
  设置是否停止/恢复接收所有视频流：
  - true：停止接收所有远端视频流。
  - false：（默认）继续接收所有远端视频流。
Returns Promise<void>

muteRemoteAudioStream

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

停止/恢复接收指定音频流。

Parameters
- uid: number
  
  指定的用户 ID。
- muted: boolean
  设置是否停止/恢复接收指定音频流：
  - true：停止接收指定用户的音频流。
  - false：（默认）继续接收指定用户的音频流。
Returns Promise<void>

muteRemoteVideoStream

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

停止/恢复接收指定视频流。

Parameters
- uid: number
  
  指定的用户 ID。
- muted: boolean
  设置是否停止/恢复接收指定视频流：
  - true：停止接收指定用户的视频流。
  - false：（默认）继续接收指定用户的视频流。
Returns Promise<void>

publish

publish(): Promise<void>

将本地音视频流发布到本频道。

该方法的调用需满足以下要求，否则 SDK 会返回 Refused(-5)：
- 该方法仅支持将音视频流发布到当前 RtcChannel 类所对应的频道。
- 直播场景下，该方法仅适用于角色为主播的用户。你可以调用该 RtcChannel 类下的 setClientRole 方法设置用户角色。
- SDK 只支持用户同一时间在一个频道发布一路音视频流。详情请参考高阶指南《多频道管理》。
Returns Promise<void>

registerMediaMetadataObserver

registerMediaMetadataObserver(): Promise<void>

注册媒体 Metadata 观测器。

该接口通过在直播的视频帧中同步添加 Metadata，实现发送商品链接、分发优惠券、发送答题等功能，构建更为丰富的直播互动方式。

Note
- 请在调用 joinChannel 加入频道前调用该方法。
- 该方法仅适用于直播场景。
Returns Promise<void>

removeAllListeners

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

删除所有的频道事件句柄。

Type parameters
- EventType: keyof RtcChannelEvents
Parameters
- Optional event: EventType
  
  事件类型。
Returns void

removeInjectStreamUrl

removeInjectStreamUrl(url: string): Promise<void>

删除输入的在线媒体流。

成功删除后，会触发 UserJoined 回调，其中 uid 为 666。

Warning

客户端输入在线媒体流功能即将停服。如果你尚未集成该功能，Agora 建议你不要使用。详见《部分服务下架计划》。

Parameters
- url: string
  
  待删除的外部视频流 URL 地址，格式为 HTTP 或 HTTPS。
Returns Promise<void>

removeListener

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

删除指定的频道事件句柄。

该方法删除指定的回调句柄。对于某些注册的回调句柄，如果你在收到相应回调事件后无需再次接收回调消息，可以调用该方法移除回调句柄。

Type parameters
- EventType: keyof RtcChannelEvents
Parameters
- event: EventType
  
  事件类型。
- listener: RtcChannelEvents[EventType]
  
  RtcChannel 对象的事件回调。
Returns void

removePublishStreamUrl

removePublishStreamUrl(url: string): Promise<void>

删除旁路推流地址。

调用该方法后，SDK 会在本地触发 RtmpStreamingStateChanged 回调，报告删除旁路推流地址的状态。

Note
- 调用该方法前，请确保已开通旁路推流的功能，详见进阶功能《推流到 CDN》中的前提条件。
- 该方法只适用于直播场景。
- 该方法每次只能删除一路旁路推流地址。若需删除多路流，则需多次调用该方法。
Parameters
- url: string
  
  待删除的推流地址，格式为 RTMP。该字符长度不能超过 1024 字节。推流地址不支持中文等特殊字符。
Returns Promise<void>

renewToken

renewToken(token: string): Promise<void>

更新 Token。

在如下情况下，SDK 判定当前的 Token 已过期：
- SDK 触发 TokenPrivilegeWillExpire 回调，或者
- SDK 在 ConnectionStateChanged 回调中报告 TokenExpired(9) 错误。
你应该在服务端重新获取 token，然后调用该方法更新 Token，否则 SDK 无法和服务器建立连接。
Parameters
- token: string
  
  新的 Token。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 1(Failed): 一般性的错误（未明确归类）。
  - 2(InvalidArgument): 参数无效。
  - 7(NotInitialized): SDK 尚未初始化。

sendMetadata

sendMetadata(metadata: string): Promise<void>

发送 metadata。

Parameters
- metadata: string
  
  需要发送的 metadata。
  
  Note 请确保在该方法中传入的 Metadata 大小不超过 setMaxMetadataSize 中设定的值。
Returns Promise<void>

sendStreamMessage

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

发送数据流。

该方法发送数据流消息到频道内所有用户。SDK 对该方法的实现进行了如下限制：
- 频道内每秒最多能发送 30 个包，且每个包最大为 1 KB。
- 每个客户端每秒最多能发送 6 KB 数据。
- 频道内每人最多能同时有 5 个数据通道。
成功调用该方法后，远端会触发 StreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 StreamMessageError 回调。
Parameters
- streamId: number
  
  createDataStream 方法返回的数据流 ID。
- message: string
  
  待发送的数据，格式为 byte[]。
Returns Promise<void>

setClientRole

setClientRole(role: ClientRole, options?: ClientRoleOptions): Promise<void>

设置直播场景下的用户角色。

在加入频道前和加入频道后均可调用该方法设置用户角色。

如果你在加入频道后调用该方法成功切换用户角色，SDK 会触发以下回调：
- 本地触发 ClientRoleChanged 回调。
- 远端触发 UserJoined 或 UserOffline(BecomeAudience) 回调。
Note
- 该方法仅在频道场景为直播（setChannelProfile 中 profile 设为 LiveBroadcasting）时生效。
- 自 3.2.0 版本起，该方法新增 options 参数，支持设置用户级别。
  - 用户角色 (role) 确定用户在 SDK 层的权限，包含是否可以发送流、是否可以接收流、是否可以推流到 CDN 等。
  - 用户级别 (level) 需要与角色结合使用，确定用户在其权限范围内，可以操作和享受到的服务级别。例如对于观众，选择接收低延时还是超低延时的视频流。不同的级别会影响计费。
Parameters
- role: ClientRole
  
  直播场景中的用户角色。详见 ClientRole。
- Optional options: ClientRoleOptions
  
  用户具体设置，包含用户级别，详见 ClientRoleOptions。
Returns Promise<void>
- 0(NoError): 方法调用成功。
- 错误码: 方法调用失败。
  - 1(Failed): 一般性的错误（未明确归类）。
  - 2(InvalidArgument): 参数无效。
  - 7(NotInitialized): SDK 尚未初始化。

setDefaultMuteAllRemoteAudioStreams

setDefaultMuteAllRemoteAudioStreams(muted: boolean): Promise<void>

设置是否默认接收音频流。
deprecated

该方法自 v3.3.0 起废弃。

默认取消或恢复订阅远端用户的音频流。

该方法需要在加入频道后调用。调用成功后，本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。

note
取消订阅音频流后，如果需要恢复订阅频道内的远端，可以进行如下操作：
- 如果需要恢复订阅单个用户的音频流，调用 muteRemoteAudioStream(false)，并指定你想要订阅的远端用户 ID。
- 如果想恢复订阅多个用户的音频流，则需要多次调用 muteRemoteAudioStream(false)。
Parameters
- muted: boolean
  是否默认取消订阅远端用户的音频流：
  - true：默认取消订阅。
  - false：（默认）默认订阅。
Returns Promise<void>

setDefaultMuteAllRemoteVideoStreams

setDefaultMuteAllRemoteVideoStreams(muted: boolean): Promise<void>

设置是否默认接收视频流。
deprecated

该方法自 v3.3.0 起废弃。

默认取消或恢复订阅远端用户的视频流。

该方法需要在加入频道后调用。调用成功后，本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。

note
取消订阅视频流后，如果需要恢复订阅频道内的远端，可以进行如下操作：
- 如果需要恢复订阅单个用户的视频流，调用 muteRemoteVideoStream(false)，并指定你想要订阅的远端用户 ID。
- 如果想恢复订阅多个用户的视频流，则需要多次调用 muteRemoteVideoStream(false)。
Parameters
- muted: boolean
  是否默认取消订阅远端用户的视频流：
  - true：默认取消订阅。
  - false：（默认）默认订阅。
Returns Promise<void>

setEncryptionMode

setEncryptionMode(encryptionMode: EncryptionMode): Promise<void>

设置内置的加密方案。
deprecated
自 v3.1.2 起废弃。请改用 enableEncryption。

Agora SDK 支持内置加密功能，默认使用 AES128XTS 加密方式。如需使用其他加密方式，可以调用该 API 设置。

同一频道内的所有用户必须设置相同的加密方式和密码才能进行通话。关于这几种加密方式的区别，请参考 AES 加密算法的相关资料。

Note
- 请勿在转码推流场景中使用该方法。
- 该方法需要在 setEncryptionSecret 之后调用。
Parameters
- encryptionMode: EncryptionMode
  
  加密方式。
Returns Promise<void>

setEncryptionSecret

setEncryptionSecret(secret: string): Promise<void>

启用内置加密，并设置数据加密密码。
deprecated
自 v3.1.2 起废弃。请改用 enableEncryption。

如果需要启用加密，请在加入频道前调用该方法启用内置加密功能，并设置加密密码。

同一频道内的所有用户应设置相同的密码。当用户离开频道时，该频道的密码会自动清除。如果未指定密码或将密码设置为空，则无法激活加密功能。

Note
- 为保证最佳传输效果，请确保加密后的数据大小不超过原始数据大小 + 16 字节。 16 字节是 AES 通用加密模式下最大填充块大小。
- 请勿在转码推流场景中使用该方法。
Parameters
- secret: string
  
  加密密码。
Returns Promise<void>

setLiveTranscoding

setLiveTranscoding(transcoding: LiveTranscoding): Promise<void>

设置直播转码。

该方法用于旁路推流的视图布局及音频设置等。调用该方法更新转码参数 LiveTranscoding 时， SDK 会触发 TranscodingUpdated 回调。

首次调用该方法设置转码参数时，不会触发 TranscodingUpdated 回调。

Note
- 请确保已开通旁路推流的功能，详见进阶功能《推流到 CDN》中的前提条件。
- 该方法仅适用于直播场景下的主播用户。
- 请确保先调用过该方法，再调用 addPublishStreamUrl。
- Agora 目前仅支持转码时向 CDN 推送 RTMPS 协议的媒体流。
Parameters
- transcoding: LiveTranscoding
  
  旁路推流布局相关设置。
Returns Promise<void>

setMaxMetadataSize

setMaxMetadataSize(size: number): Promise<void>

设置 Metadata 的最大数据大小。

Parameters
- size: number
  
  Metadata 的最大数据大小，单位为 Byte，最大值不超过 1024。
Returns Promise<void>

setRemoteDefaultVideoStreamType

setRemoteDefaultVideoStreamType(streamType: VideoStreamType): Promise<void>

设置默认订阅的视频流类型。

Parameters
- streamType: VideoStreamType
  
  设置视频流大小类型。
Returns Promise<void>

setRemoteUserPriority

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

设置用户媒体流优先级。

该方法可以与 setRemoteSubscribeFallbackOption 搭配使用。如果将某个用户的优先级设为高，那么发给这个用户的音视频流的优先级就会高于其他用户。

Note

Agora SDK 仅允许将一名远端用户设为高优先级。

Parameters
- uid: number
  
  远端用户的 ID。
- userPriority: UserPriority
  
  远端用户的需求优先级。
Returns Promise<void>

setRemoteVideoStreamType

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

设置订阅的视频流类型。

在网络条件受限的情况下，如果发送端没有调用 enableDualStreamMode 关闭双流模式，接收端可以选择接收大流还是小流。其中，大流可以接为高分辨率高码率的视频流，小流则是低分辨率低码率的视频流。

正常情况下，用户默认接收大流。如需节约带宽和计算资源，则可以调用该方法动态调整对应远端视频流的大小。 SDK 会根据该方法中的设置，切换大小流。

视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。

note

该方法在加入频道前后都能调用。如果既调用了 setRemoteVideoStreamType，也调用了 setRemoteDefaultVideoStreamType，则 SDK 以 setRemoteVideoStreamType 中的设置为准。

Parameters
- uid: number
  
  远端用户的 ID。
- streamType: VideoStreamType
  
  设置视频流大小类型。
Returns Promise<void>

setRemoteVoicePosition

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

设置远端用户声音的空间位置和音量，方便本地用户听声辨位。

用户通过调用该接口，设置远端用户声音出现的位置，左右声道的声音差异会让用户产生声音的方位感，从而判断出远端用户的实时位置。在多人在线游戏场景，如吃鸡游戏中，该方法能有效增加游戏角色的方位感，模拟真实场景。

Note
- 使用该方法需要在加入频道前调用 enableSoundPositionIndication 开启远端用户的语音立体声。
- 为获得最佳听觉体验，我们建议用户佩戴耳机。
Parameters
- uid: number
  
  远端用户的 ID。
- pan: number
  设置远端用户声音出现的位置，取值范围为 [-1.0,1.0]：
  - 0.0：（默认）声音出现在正前方。
  - -1.0：声音出现在左边。
  - 1.0：声音出现在右边。
- gain: number
  
  设置远端用户声音的音量，取值范围为 [0.0,100.0]，默认值为 100.0，表示该用户的原始音量。取值越小，则音量越低。
Returns Promise<void>

startChannelMediaRelay

startChannelMediaRelay(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration): Promise<void>

开始跨频道媒体流转发。

成功调用该方法后，SDK 会触发 ChannelMediaRelayStateChanged 和 ChannelMediaRelayEvent 回调，并在回调中报告当前的跨频道媒体流转发状态和事件。
- 如果 ChannelMediaRelayStateChanged 回调报告 Running(2) 和 None(0)，且 ChannelMediaRelayEvent 回调报告 SentToDestinationChannel(4)，则表示 SDK 开始在源频道和目标频道之间转发媒体流。
- 如果 ChannelMediaRelayStateChanged 回调报告 Failure(3)，则表示跨频道媒体流转发出现异常。
Note
- 跨频道媒体流转发功能需要联系 sales@agora.io 开通。
- 该功能不支持 String 型 UID。
- 请在成功加入频道后调用该方法。
- 该方法仅适用于直播场景下的主播。
- 成功调用该方法后，若你想再次调用该方法，必须先调用 stopChannelMediaRelay 方法退出当前的转发状态。
Parameters
- channelMediaRelayConfiguration: ChannelMediaRelayConfiguration
  
  跨频道媒体流转发参数配置。
Returns Promise<void>

stopChannelMediaRelay

stopChannelMediaRelay(): Promise<void>

停止跨频道媒体流转发。

一旦停止，主播会退出所有目标频道。

成功调用该方法后，SDK 会触发 ChannelMediaRelayStateChanged 回调。如果报告 Idle(0) 和 None(0)，则表示已停止转发媒体流。

Note

如果该方法调用不成功，SDK 会触发 ChannelMediaRelayStateChanged 回调，并报告状态码 ServerNoResponse(2) 或 ServerConnectionLost(8)。你可以调用 leaveChannel 方法离开频道，跨频道媒体流转发会自动停止。

Returns Promise<void>

unpublish

unpublish(): Promise<void>

停止将本地音视频流发布到本频道。

请确保你想要停止发布音视频流的频道 channelId，与当前正在 publish 音视频流的频道 channelId 一致，否则 SDK 会返回 Refused(-5)。

Returns Promise<void>

unregisterMediaMetadataObserver

unregisterMediaMetadataObserver(): Promise<void>

注销媒体 Metadata 观测器。

Returns Promise<void>

updateChannelMediaRelay

updateChannelMediaRelay(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration): Promise<void>

更新媒体流转发的频道。

成功开始跨频道转发媒体流后，如果你希望将流转发到多个目标频道，或退出当前的转发频道，可以调用该方法。

成功调用该方法后，SDK 会触发 ChannelMediaRelayEvent 回调，并在回调中报告状态码 UpdateDestinationChannel(7)。

Note
- 请在 startChannelMediaRelay 方法后调用该方法，更新媒体流转发的频道。
- 跨频道媒体流转发最多支持 4 个目标频道。
Parameters
- channelMediaRelayConfiguration: ChannelMediaRelayConfiguration
  
  跨频道媒体流转发参数配置。
Returns Promise<void>

Static create

create(channelId: string): Promise<RtcChannel>

创建并返回 RtcChannel 对象。

你可以多次调用该方法，创建多个 RtcChannel 对象，再调用各 RtcChannel 对象中的 joinChannel 方法，实现同时加入多个频道。

加入多个频道后，你可以同时订阅各个频道的音、视频流；但是同一时间只能在一个频道发布一路音、视频流。

Parameters
- channelId: string
  标识通话的频道名称，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 89 个字符）：
  - 26 个小写英文字母 a-z
  - 26 个大写英文字母 A-Z
  - 10 个数字 0-9
  - 空格
  - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
  Note
  - 该参数没有默认值，请确保对参数设值。
  - 请勿将该参数设为空字符 ""，否则 SDK 会返回 Refused(-5)。
Returns Promise<RtcChannel>
- 方法调用成功，返回 RtcChannel 对象。
- 方法调用失败，返回 null。
- 如果将 channelId 设为空字符 ""，则返回错误码 Refused(-5)。

Static destroyAll

destroyAll(): void

销毁所有的 RtcChannel 对象。

Returns void

Agora React Native API Reference

Hierarchy

Implements

Index

Methods

Methods

addInjectStreamUrl

Parameters

url: string

config: LiveInjectStreamConfig

Returns Promise<void>

addListener

Type parameters

EventType: keyof RtcChannelEvents

Parameters

event: EventType

listener: RtcChannelEvents[EventType]

Returns Subscription

addPublishStreamUrl

Parameters

url: string

transcodingEnabled: boolean

Returns Promise<void>

adjustUserPlaybackSignalVolume

Parameters

uid: number

volume: number

Returns Promise<void>

createDataStream

Parameters

reliable: boolean

ordered: boolean

Returns Promise<number>

createDataStreamWithConfig

Parameters

config: DataStreamConfig

Returns Promise<number>

destroy

Returns Promise<void>

enableEncryption

Parameters

enabled: boolean

config: EncryptionConfig

Returns Promise<void>

getCallId

Returns Promise<string>

getConnectionState

Returns Promise<ConnectionStateType>

joinChannel

Parameters

token: string | undefined | null

optionalInfo: string | undefined | null

optionalUid: number

options: ChannelMediaOptions

Returns Promise<void>

joinChannelWithUserAccount

Parameters

token: string | undefined | null

userAccount: string

options: ChannelMediaOptions

Returns Promise<void>

leaveChannel

Returns Promise<void>

muteAllRemoteAudioStreams

Parameters

muted: boolean

Returns Promise<void>

muteAllRemoteVideoStreams

Parameters

muted: boolean

Returns Promise<void>

muteRemoteAudioStream

Parameters

uid: number

muted: boolean

Returns Promise<void>

muteRemoteVideoStream

Parameters

uid: number

muted: boolean