Skip to content

Commit

Permalink
ENDOC-285 rtc doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
nirm2009 committed Jun 28, 2024
1 parent a7f7565 commit 6fd5190
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
val options = ChannelMediaOptions()
options.publishCustomAudioTrack = true // Enable publishing custom audio
options.publishCustomAudioTrackId = customAudioTrackId
options.publishMicrophoneTrack = false // Disable publishing microphone audio
options.publishMicrophoneTrack = false // Disable publishing microphone-captured audio
agoraEngine!!.updateChannelMediaOptions(options)

// Open the audio file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// Start or stop publishing the media player tracks
channelOptions.publishMediaPlayerAudioTrack = publishMediaPlayer
channelOptions.publishMediaPlayerVideoTrack = publishMediaPlayer
// Stop or start publishing the microphone and camera tracks
// Stop or start publishing the microphone-captured and camera-captured tracks
channelOptions.publishMicrophoneTrack = !publishMediaPlayer
channelOptions.publishCameraTrack = !publishMediaPlayer
// Specify the media player Id for publishing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ To push audio from a custom source to a channel, take the following steps:
When a user presses **Join**, you set the `ChannelMediaOptions` to disable the microphone audio track and enable the custom audio track. You also enable custom audio local playback and set the external audio source. To do this, add the following lines to the `joinChannel(View view)` method in the `MainActivity` class after `options.clientRoleType = Constants.CLIENT_ROLE_BROADCASTER;`:

```java
options.publishMicrophoneTrack = false; // Disable publishing microphone audio
options.publishMicrophoneTrack = false; // Disable publishing microphone-captured audio
options.publishCustomAudioTrack = true; // Enable publishing custom audio
options.enableAudioRecordingOrPlayout = true;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ In the following code example, you create the basic framework required to push v
You use `ChannelMediaOptions` to stop publishing the local video track and start publishing the custom video track. Create an instance of `ChannelMediaOptions` and set `publishVideoTrack` to `false` and `customVideoTrack` to `true`, then update the channel media options in your channel by calling `updateChannelMediaOptions`. To impelement this logic, in your script file, add the following at the end of `Join`:

```csharp
options.publishCameraTrack.SetValue(false); // Disable publishing camera track.
options.publishCameraTrack.SetValue(false); // Disable publishing camera-captured video track.
options.publishCustomVideoTrack.SetValue(true); // Enable publishing custom video track.
RtcEngine.UpdateChannelMediaOptions(options);// Update channel media option to play the custom video track.
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ In this section you create the basic framework required to push video frames fro
options.clientRoleType = CLIENT_ROLE_BROADCASTER;
options.autoSubscribeAudio = true;
options.autoSubscribeVideo = true;
options.publishCameraTrack = false; // Disable publishing video track.
options.publishCameraTrack = false; // Disable publishing camera-captured video track.
options.publishCustomVideoTrack = true; // Enable publishing custom video track.
options.publishMicrophoneTrack = false;
agoraEngine->updateChannelMediaOptions(options);
Expand Down Expand Up @@ -126,7 +126,7 @@ To push audio from a custom source to a channel, take the following steps:

```cpp
ChannelMediaOptions options;
options.publishMicrophoneTrack = false; // Disable publishing microphone audio
options.publishMicrophoneTrack = false; // Disable publishing microphone-captured audio
options.publishCustomAudioTrack = true; // Enable publishing custom audio
options.enableAudioRecordingOrPlayout = true;
agoraEngine->enableCustomAudioLocalPlayback(0, true);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ agoraKit.stopScreenCapture()
option.publishScreenCaptureVideo = false
// Stop sharing captured audio in the channel
option.publishScreenCaptureAudio = false
// Publish camera video in the channel
// Publish camera-captured video in the channel
option.publishCameraTrack = true
agoraKit.updateChannel(with: option)
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ public class MainActivity extends AppCompatActivity {
options.channelProfile = Constants.CHANNEL_PROFILE_COMMUNICATION;
// Set the user role to BROADCASTER (host) or AUDIENCE (audience)
options.clientRoleType = Constants.CLIENT_ROLE_BROADCASTER;
// Publish the audio collected by the microphone
// Publish the audio captured by the microphone
options.publishMicrophoneTrack = true;
// Automatically subscribe to all audio streams
options.autoSubscribeAudio = true;
Expand Down Expand Up @@ -882,7 +882,7 @@ ChannelMediaOptions options = new ChannelMediaOptions();
options.clientRoleType = Constants.CLIENT_ROLE_BROADCASTER;
// In the live broadcast scenario, set the channel profile to BROADCASTING (live broadcast scenario)
options.channelProfile = Constants.CHANNEL_PROFILE_LIVE_BROADCASTING;
// Publish the audio collected by the microphone
// Publish the audio captured by the microphone
options.publishMicrophoneTrack = true;
// Automatically subscribe to all audio streams
options.autoSubscribeAudio = true;
Expand Down

0 comments on commit 6fd5190

Please sign in to comment.