Agora RTC Objective-C API Reference  Refactor
Data Fields
ChannelMediaOptions Struct Reference

Data Fields

Optional< bool > publishCameraTrack
 
Optional< bool > publishSecondaryCameraTrack
 
Optional< bool > publishMicrophoneTrack
 
Optional< bool > publishScreenCaptureVideo
 
Optional< bool > publishScreenCaptureAudio
 
Optional< bool > publishCustomAudioTrack
 
Optional< int > publishCustomAudioSourceId
 
Optional< bool > publishCustomAudioTrackEnableAec
 
Optional< bool > publishDirectCustomAudioTrack
 
Optional< bool > publishCustomAudioTrackAec
 
Optional< bool > publishCustomVideoTrack
 
Optional< bool > publishEncodedVideoTrack
 
Optional< bool > publishMediaPlayerAudioTrack
 
Optional< bool > publishMediaPlayerVideoTrack
 
Optional< bool > publishTrancodedVideoTrack
 
Optional< bool > autoSubscribeAudio
 
Optional< bool > autoSubscribeVideo
 
Optional< bool > enableAudioRecordingOrPlayout
 
Optional< int > publishMediaPlayerId
 
Optional< CLIENT_ROLE_TYPEclientRoleType
 
Optional< AUDIENCE_LATENCY_LEVEL_TYPEaudienceLatencyLevel
 
Optional< VIDEO_STREAM_TYPEdefaultVideoStreamType
 
Optional< CHANNEL_PROFILE_TYPEchannelProfile
 
Optional< int > audioDelayMs
 
Optional< int > mediaPlayerAudioDelayMs
 
Optional< const char * > token
 
Optional< bool > enableBuiltInMediaEncryption
 
Optional< bool > publishRhythmPlayerTrack
 
Optional< bool > isInteractiveAudience
 
Optional< video_track_id_tcustomVideoTrackId
 
Optional< bool > isAudioFilterable
 

Detailed Description

The channel media options.

Constructor & Destructor Documentation

◆ ChannelMediaOptions()

ChannelMediaOptions ( )
inline

◆ ~ChannelMediaOptions()

~ChannelMediaOptions ( )
inline

Member Function Documentation

◆ SetAll()

void SetAll ( const ChannelMediaOptions change)
inline

◆ operator==()

bool operator== ( const ChannelMediaOptions o) const
inline

◆ operator=()

ChannelMediaOptions& operator= ( const ChannelMediaOptions replace)
inline

Field Documentation

◆ publishCameraTrack

Optional<bool> publishCameraTrack

Determines whether to publish the video of the camera track.

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

◆ publishSecondaryCameraTrack

Optional<bool> publishSecondaryCameraTrack

Determines whether to publish the video of the secondary camera track.

  • true: Publish the video track of the secondary camera capturer.
  • false: (Default) Do not publish the video track of the secondary camera capturer.

◆ publishMicrophoneTrack

Optional<bool> publishMicrophoneTrack

Determines whether to publish the recorded audio.

  • true: Publish the recorded audio.
  • false: (Default) Do not publish the recorded audio.

◆ publishScreenCaptureVideo

Optional<bool> publishScreenCaptureVideo

Determines whether to publish the video track of the screen capturer.

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

◆ publishScreenCaptureAudio

Optional<bool> publishScreenCaptureAudio

Determines whether to publish the audio track of the screen capturer.

  • true: Publish the video audio of the screen capturer.
  • false: (Default) Do not publish the audio track of the screen capturer.

◆ publishCustomAudioTrack

Optional<bool> publishCustomAudioTrack

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

  • true: Publish the audio of the custom audio track.
  • false: (Default) Do not publish the audio of the custom audio track.

◆ publishCustomAudioSourceId

Optional<int> publishCustomAudioSourceId

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

◆ publishCustomAudioTrackEnableAec

Optional<bool> publishCustomAudioTrackEnableAec

Determines whether to enable AEC when publish custom audio track.

  • true: Enable AEC.
  • false: (Default) Do not enable AEC.

◆ publishDirectCustomAudioTrack

Optional<bool> publishDirectCustomAudioTrack

Determines whether to publish direct custom audio track.

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

◆ publishCustomAudioTrackAec

Optional<bool> publishCustomAudioTrackAec

Determines whether to publish AEC custom audio track.

  • true: Publish AEC track.
  • false: (Default) Do not publish AEC track.

◆ publishCustomVideoTrack

Optional<bool> publishCustomVideoTrack

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

  • true: Publish the video of the custom video track.
  • false: (Default) Do not publish the video of the custom video track.

◆ publishEncodedVideoTrack

Optional<bool> publishEncodedVideoTrack

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

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

◆ publishMediaPlayerAudioTrack

Optional<bool> publishMediaPlayerAudioTrack

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

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

◆ publishMediaPlayerVideoTrack

Optional<bool> publishMediaPlayerVideoTrack

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.

◆ publishTrancodedVideoTrack

Optional<bool> publishTrancodedVideoTrack

Determines whether to publish the local transcoded video track.

  • true: Publish the video track of local transcoded video track.
  • false: (default) Do not publish the local transcoded video track.

◆ autoSubscribeAudio

Optional<bool> autoSubscribeAudio

Determines whether to subscribe to all audio streams automatically. It can replace calling setDefaultMuteAllRemoteAudioStreams before joining a channel.

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

◆ autoSubscribeVideo

Optional<bool> autoSubscribeVideo

Determines whether to subscribe to all video streams automatically. It can replace calling setDefaultMuteAllRemoteVideoStreams before joining a channel.

  • true: Subscribe to all video streams automatically.
  • false: (Default) do not subscribe to any video stream automatically.

◆ enableAudioRecordingOrPlayout

Optional<bool> enableAudioRecordingOrPlayout

Determines whether to enable audio recording or playout.

  • true: It's used to publish audio and mix microphone, or subscribe audio and playout
  • false: It's used to publish extenal audio frame only without mixing microphone, or no need audio device to playout audio either

◆ publishMediaPlayerId

Optional<int> publishMediaPlayerId

Determines which media player source should be published.

  • DEFAULT_PLAYER_ID(0) is default.

◆ clientRoleType

Optional<CLIENT_ROLE_TYPE> clientRoleType

The client role type: CLIENT_ROLE_TYPE.

◆ audienceLatencyLevel

Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel

The audience latency level type. See AUDIENCE_LATENCY_LEVEL_TYPE

◆ defaultVideoStreamType

Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType

The default video stream type: VIDEO_STREAM_TYPE.

◆ channelProfile

Optional<CHANNEL_PROFILE_TYPE> channelProfile

The channel profile: CHANNEL_PROFILE_TYPE.

◆ audioDelayMs

Optional<int> audioDelayMs

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

Optional<int> mediaPlayerAudioDelayMs

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

Optional<const char*> token

The token

◆ enableBuiltInMediaEncryption

Optional<bool> enableBuiltInMediaEncryption

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

  • false is default.

◆ publishRhythmPlayerTrack

Optional<bool> publishRhythmPlayerTrack

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.

◆ isInteractiveAudience

Optional<bool> isInteractiveAudience

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.

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

◆ customVideoTrackId

Optional<video_track_id_t> customVideoTrackId

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

◆ isAudioFilterable

Optional<bool> isAudioFilterable

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.