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

Inherits <NSObject>.

Properties

AgoraRtcBoolOptional *_Nullable publishCameraTrack
 
AgoraRtcBoolOptional *_Nullable publishScreenCaptureVideo
 
AgoraRtcBoolOptional *_Nullable publishScreenCaptureAudio
 
AgoraRtcBoolOptional *_Nullable publishCustomAudioTrack
 
AgoraRtcBoolOptional *_Nullable publishCustomAudioTrackEnableAec
 
AgoraRtcBoolOptional *_Nullable publishCustomAudioTrackAec
 
AgoraRtcBoolOptional *_Nullable publishDirectCustomAudioTrack
 
AgoraRtcBoolOptional *_Nullable publishCustomVideoTrack
 
AgoraRtcBoolOptional *_Nullable publishEncodedVideoTrack
 
AgoraRtcBoolOptional *_Nullable publishMediaPlayerAudioTrack
 
AgoraRtcBoolOptional *_Nullable publishMediaPlayerVideoTrack
 
AgoraRtcIntOptional *_Nullable publishMediaPlayerId
 
AgoraRtcIntOptional *_Nullable publishCustomAudioSourceId
 
AgoraRtcBoolOptional *_Nullable publishMicrophoneTrack
 
AgoraRtcBoolOptional *_Nullable autoSubscribeAudio
 
AgoraRtcBoolOptional *_Nullable autoSubscribeVideo
 
AgoraRtcBoolOptional *_Nullable startPreview
 
AgoraRtcBoolOptional *_Nullable enableAudioRecordingOrPlayout
 
AgoraRtcIntOptional *_Nullable clientRoleType
 
AgoraRtcIntOptional *_Nullable audienceLatencyLevel
 
AgoraRtcIntOptional *_Nullable defaultVideoStreamType
 
AgoraRtcIntOptional *_Nullable channelProfile
 
AgoraRtcIntOptional *_Nullable audioDelayMs
 
AgoraRtcIntOptional *_Nullable mediaPlayerAudioDelayMs
 
NSString *_Nullable token
 
AgoraRtcBoolOptional *_Nullable enableBuiltInMediaEncryption
 
AgoraRtcBoolOptional *_Nullable publishRhythmPlayerTrack
 
AgoraRtcIntOptional *_Nullable customVideoTrackId
 
AgoraRtcBoolOptional *_Nullable isAudioFilterable
 
AgoraRtcBoolOptional *_Nullable isInteractiveAudience
 

Detailed Description

The channel media options.

Property Documentation

◆ publishCameraTrack

- (AgoraRtcBoolOptional* _Nullable) publishCameraTrack
readwritenonatomicstrong

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.

◆ publishScreenCaptureVideo

- (AgoraRtcBoolOptional* _Nullable) publishScreenCaptureVideo
readwritenonatomicstrong

Determines whether to publish the video of the screen capturer.

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

◆ publishScreenCaptureAudio

- (AgoraRtcBoolOptional* _Nullable) publishScreenCaptureAudio
readwritenonatomicstrong

Determines whether to publish the audio of the screen capturer.

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

◆ publishCustomAudioTrack

- (AgoraRtcBoolOptional* _Nullable) publishCustomAudioTrack
readwritenonatomicstrong

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.

◆ publishCustomAudioTrackEnableAec

- (AgoraRtcBoolOptional* _Nullable) publishCustomAudioTrackEnableAec
readwritenonatomicstrong

Determines whether to enable AEC when publish custom audio track.

  • YES: Enable AEC.
  • NO: (Default) Do not enable AEC.

◆ publishCustomAudioTrackAec

- (AgoraRtcBoolOptional* _Nullable) publishCustomAudioTrackAec
readwritenonatomicstrong

Determines whether to publish AEC custom audio track.

  • YES: Publish AEC track.
  • NO: (Default) Do not publish AEC track.

◆ publishDirectCustomAudioTrack

- (AgoraRtcBoolOptional* _Nullable) publishDirectCustomAudioTrack
readwritenonatomicstrong

Determines whether to publish direct custom audio track.

  • true: publish.
  • false: (Default) Do not publish.

◆ publishCustomVideoTrack

- (AgoraRtcBoolOptional* _Nullable) publishCustomVideoTrack
readwritenonatomicstrong

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

- (AgoraRtcBoolOptional* _Nullable) publishEncodedVideoTrack
readwritenonatomicstrong

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

- (AgoraRtcBoolOptional* _Nullable) publishMediaPlayerAudioTrack
readwritenonatomicstrong

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.

◆ publishMediaPlayerVideoTrack

- (AgoraRtcBoolOptional* _Nullable) publishMediaPlayerVideoTrack
readwritenonatomicstrong

Determines whether to publish the video track of media player source.

  • true: Publish the video track of media player source.
  • false: (default) Do not publish the video track of media player source.

◆ publishMediaPlayerId

- (AgoraRtcIntOptional* _Nullable) publishMediaPlayerId
readwritenonatomicstrong

Determines which media player source should be published.

  • DEFAULT_PLAYER_ID(0) is default.

◆ publishCustomAudioSourceId

- (AgoraRtcIntOptional* _Nullable) publishCustomAudioSourceId
readwritenonatomicstrong

Determines the source id of the custom audio, default is 0.

◆ publishMicrophoneTrack

- (AgoraRtcBoolOptional* _Nullable) publishMicrophoneTrack
readwritenonatomicstrong

Determines whether to publish the sampled audio.

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

◆ autoSubscribeAudio

- (AgoraRtcBoolOptional* _Nullable) autoSubscribeAudio
readwritenonatomicstrong

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

- (AgoraRtcBoolOptional* _Nullable) autoSubscribeVideo
readwritenonatomicstrong

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.

◆ startPreview

- (AgoraRtcBoolOptional* _Nullable) startPreview
readwritenonatomicstrong

Determines whether to start preview when join channel if canvas have been set.

  • true: (Default) start preview when join channel.
  • false: Do not start preview.

◆ enableAudioRecordingOrPlayout

- (AgoraRtcBoolOptional* _Nullable) enableAudioRecordingOrPlayout
readwritenonatomicstrong

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

- (AgoraRtcIntOptional* _Nullable) clientRoleType
readwritenonatomicstrong

The client role type: AgoraClientRole.

◆ audienceLatencyLevel

- (AgoraRtcIntOptional* _Nullable) audienceLatencyLevel
readwritenonatomicstrong

The audience latency level type: AgoraAudienceLatencyLevelType.

◆ defaultVideoStreamType

- (AgoraRtcIntOptional* _Nullable) defaultVideoStreamType
readwritenonatomicstrong

The default video stream type: AgoraVideoStreamType.

◆ channelProfile

- (AgoraRtcIntOptional* _Nullable) channelProfile
readwritenonatomicstrong

The channel profile: AgoraChannelProfile.

◆ audioDelayMs

- (AgoraRtcIntOptional* _Nullable) audioDelayMs
readwritenonatomicstrong

The delay in ms for sending audio frames. This is used for explicit control of A/V sync. To switch off the delay, set the value to zero.

◆ mediaPlayerAudioDelayMs

- (AgoraRtcIntOptional* _Nullable) mediaPlayerAudioDelayMs
readwritenonatomicstrong

The delay in ms for sending media player audio frames. This is used for explicit control of A/V sync. To switch off the delay, set the value to zero.

◆ token

- (NSString* _Nullable) token
readwritenonatomiccopy

The token to be renewed

◆ enableBuiltInMediaEncryption

- (AgoraRtcBoolOptional* _Nullable) enableBuiltInMediaEncryption
readwritenonatomicstrong

Enable media packet encryption. This parameter is ignored when calling function updateChannelMediaOptions()

◆ publishRhythmPlayerTrack

- (AgoraRtcBoolOptional* _Nullable) publishRhythmPlayerTrack
readwritenonatomicstrong

Determines whether to publish the sound of the rhythm player to remote users.

  • true: (Default) Publish the sound of the rhythm player.
  • false: Do not publish the sound of the rhythm player.

◆ customVideoTrackId

- (AgoraRtcIntOptional* _Nullable) customVideoTrackId
readwritenonatomicstrong

The custom video track id which will used to publish or preview

◆ isAudioFilterable

- (AgoraRtcBoolOptional* _Nullable) isAudioFilterable
readwritenonatomicstrong

Determines whether local audio stream can be filtered .

  • true: (Default) Can be filtered when audio level is low.
  • false: Do not Filter this audio stream.

◆ isInteractiveAudience

- (AgoraRtcBoolOptional* _Nullable) isInteractiveAudience
readwritenonatomicstrong

This mode is only used for audience. In PK mode, client might join one channel as broadcaster, and join another channel as interactive audience to achieve low lentancy and smooth video from remote user.

  • YES: Enable low lentancy and smooth video when joining as an audience.
  • NO: (default) Use default settings for audience role.