Agora RTC Objective-C API Reference  Refactor
Properties
AgoraRtcChannelMediaOptions Class Reference

Inherits <NSObject>.

Properties

BOOL publishCameraTrack
 
BOOL publishSecondaryCameraTrack
 
BOOL publishScreenTrack
 
BOOL publishCustomAudioTrack
 
BOOL publishCustomVideoTrack
 
BOOL publishEncodedVideoTrack
 
BOOL publishMediaPlayerAudioTrack
 
BOOL publishAudioTrack
 
BOOL autoSubscribeAudio
 
BOOL autoSubscribeVideo
 
BOOL enableAudioRecordingOrPlayout
 
AgoraClientRole clientRoleType
 
AgoraVideoStreamType defaultVideoStreamType
 
AgoraChannelProfile channelProfile
 
unsigned int connectionId
 

Detailed Description

The channel media options.

Property Documentation

◆ publishCameraTrack

- (BOOL) publishCameraTrack
readwritenonatomicassign

Determines whether to publish the video of the camera track.

  • YES: (Default) Publish the video track of the camera capturer.
  • NO: Do not publish the video track of the camera capturer.

◆ publishSecondaryCameraTrack

- (BOOL) publishSecondaryCameraTrack
readwritenonatomicassign

Determines whether to publish the video of the multi-camera track.

  • YES: Publish the video track of the multiple camera capturers.
  • NO: (Default) Do not publish the video track of the camera capturers.

◆ publishScreenTrack

- (BOOL) publishScreenTrack
readwritenonatomicassign

Determines whether to publish the video of the screen track.

  • YES: Publish the video track of the screen capturer.
  • NO: (Default) Do not publish the video track of the screen capturer.

◆ publishCustomAudioTrack

- (BOOL) publishCustomAudioTrack
readwritenonatomicassign

Determines whether to publish the audio of the custom audio track.

  • YES: Publish the audio of the custom audio track.
  • NO: (Default) Do not publish the audio of the custom audio track.

◆ publishCustomVideoTrack

- (BOOL) publishCustomVideoTrack
readwritenonatomicassign

Determines whether to publish the video of the custom video track.

  • YES: Publish the video of the custom video track.
  • NO: (Default) Do not publish the video of the custom video track.

◆ publishEncodedVideoTrack

- (BOOL) publishEncodedVideoTrack
readwritenonatomicassign

Determines whether to publish the video of the encoded video track.

  • YES: Publish the video of the encoded video track.
  • NO: (Default) Do not publish the video of the encoded video track.

◆ publishMediaPlayerAudioTrack

- (BOOL) publishMediaPlayerAudioTrack
readwritenonatomicassign

Determines whether to publish the audio track of media player.

  • YES: Publish the audio track of media player.
  • NO: (Default) Do not publish the audio track of media player.

◆ publishAudioTrack

- (BOOL) publishAudioTrack
readwritenonatomicassign

Determines whether to publish the sampled audio.

  • YES: (Default) Publish the sampled audio.
  • NO: Do not publish the sampled audio.

◆ autoSubscribeAudio

- (BOOL) autoSubscribeAudio
readwritenonatomicassign

Determines whether to subscribe to all audio streams automatically. This property replaces calling setDefaultMuteAllRemoteAudioStreams before joining a channel.

  • YES: (Default) Subscribe to all audio streams automatically.
  • NO: Do not subscribe to any audio stream automatically.

◆ autoSubscribeVideo

- (BOOL) autoSubscribeVideo
readwritenonatomicassign

Determines whether to subscribe to all video streams automatically. This property replaces calling setDefaultMuteAllRemoteVideoStreams before joining a channel.

  • YES: Subscribe to all video streams automatically.
  • NO: (default) Do not subscribe to any video stream automatically.

◆ enableAudioRecordingOrPlayout

- (BOOL) enableAudioRecordingOrPlayout
readwritenonatomicassign

Determines whether to subscribe to PCM audio data only. Note that it only takes effect when join channel, otherwise not when update channel media option.

  • YES: Subscribe to PCM audio data only, which means that the remote audio stream is not be played by the built-in playback device automatically. You can use this mode to pull PCM data and handle playback.
  • NO: (default) Do not subscribe to PCM audio only, which means that the remote audio stream is played automatically.

◆ clientRoleType

- (AgoraClientRole) clientRoleType
readwritenonatomicassign

The client role type: AgoraClientRole.

◆ defaultVideoStreamType

- (AgoraVideoStreamType) defaultVideoStreamType
readwritenonatomicassign

The default video stream type: AgoraVideoStreamType.

◆ channelProfile

- (AgoraChannelProfile) channelProfile
readwritenonatomicassign

The channel profile: AgoraChannelProfile.

◆ connectionId

- (unsigned int) connectionId
readwriteatomicassign

The connectionId, which supports a user to join the same channel with different connectionIds. ConnectionId could be obtained by joinChannelEx series defined in AgoraRtcEngineKitEx.h