Instance Methods | |
(int) | - joinChannelExByToken:channelId:uid:connectionId:delegate:mediaOptions:joinSuccess: |
(int) | - leaveChannelEx:connectionId:leaveChannelBlock: |
(int) | - setupRemoteVideoEx:connectionId: |
(int) | - setRemoteRenderModeEx:mode:connectionId: |
- (int) joinChannelExByToken: | (NSString *_Nullable) | token | |
channelId: | (NSString *_Nonnull) | channelId | |
uid: | (NSUInteger) | uid | |
connectionId: | (unsigned int *) | connectionId | |
delegate: | (id< AgoraRtcEngineDelegate > _Nullable) | delegate | |
mediaOptions: | (AgoraRtcChannelMediaOptions *_Nonnull) | mediaOptions | |
joinSuccess: | (void(^)(NSString *_Nonnull channel, NSUInteger uid, NSInteger elapsed)) | joinSuccessBlock | |
Joins a channel.
You can call this method multiple times to join multiple channels.
token | The token for authentication.
|
channelId | Unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
|
uid | User ID. A 32-bit unsigned integer with a value ranging from 1 to (232-1). The uid must be unique. If a uid is not assigned (or set to 0), the SDK assigns and returns a uid in the callback. Your app must record and maintain the returned uid since the SDK does not do so. |
connectionId | pointer to connection ID (out param). |
delegate | AgoraRtcEngineDelegate protocol. |
mediaOptions | AgoraRtcChannelMediaOptions Object. |
joinSuccessBlock | Same as didJoinChannel. We recommend you set this parameter as nil to use didJoinChannel .
|
Extends class AgoraRtcEngineKit.
- (int) leaveChannelEx: | (NSString *_Nonnull) | channelId | |
connectionId: | (unsigned int) | connectionId | |
leaveChannelBlock: | (void(^)(AgoraChannelStats *_Nonnull stat)) | leaveChannelBlock | |
Leaves the channel by ID.
channelId | channel ID |
connectionId | connection ID |
leaveChannelBlock | This callback indicates that a user leaves a channel, and provides the statistics of the call in AgoraChannelStats. |
Extends class AgoraRtcEngineKit.
- (int) setupRemoteVideoEx: | (AgoraRtcVideoCanvas *_Nonnull) | remote | |
connectionId: | (unsigned int) | connectionId | |
Binds the remote user to the video display window, that is, sets the view for the user of the specified uid.
Usually, the application should specify the uid of the remote video in the method call before the user enters a channel. If the remote uid is unknown to the application, you can set the uid after receiving the didJoinedOfUid event.
remote | AgoraRtcVideoCanvas |
connectionId | connection ID. |
Extends class AgoraRtcEngineKit.
- (int) setRemoteRenderModeEx: | (NSUInteger) | uid | |
mode: | (AgoraVideoRenderMode) | mode | |
connectionId: | (unsigned int) | connectionId | |
Configures the remote video display mode. The application can call this method multiple times to change the display mode.
uid | User id of the user whose video streams are received. |
mode | AgoraVideoRenderMode |
connectionId | connection ID. |
Extends class AgoraRtcEngineKit.