Skip to content

Commit

Permalink
[AUTO] Generate codes by terra (#765)
Browse files Browse the repository at this point in the history
Co-authored-by: guoxianzhe <guoxianzhe@users.noreply.github.com>
  • Loading branch information
sda-rob and guoxianzhe authored Jan 30, 2024
1 parent 5fc5c80 commit 249d92d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 21 deletions.
6 changes: 3 additions & 3 deletions src/AgoraBase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ export enum VideoCodecCapabilityLevel {
*/
export enum VideoCodecType {
/**
* @ignore
* 0: (Default) Unspecified codec format. The SDK automatically matches the appropriate codec format based on the current video stream's resolution and device performance.
*/
VideoCodecNone = 0,
/**
Expand All @@ -863,7 +863,7 @@ export enum VideoCodecType {
*/
VideoCodecH264 = 2,
/**
* 3: (Default) Standard H.265. In certain scenarios, such as low resolution of the captured video stream or limited device performance, the SDK automatically adjusts to the H.264 encoding format.
* 3: Standard H.265.
*/
VideoCodecH265 = 3,
/**
Expand Down Expand Up @@ -4549,7 +4549,7 @@ export class EchoTestConfiguration {
*/
enableAudio?: boolean;
/**
* Whether to enable the video device for the loop test: true : (Default) Enable the video device. To test the video device, set this parameter as true. false : Disable the video device.
* Whether to enable the video device for the loop test. Currently, video device loop test is not supported. Please set this parameter to false.
*/
enableVideo?: boolean;
/**
Expand Down
21 changes: 5 additions & 16 deletions src/IAgoraRtcEngine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1511,7 +1511,6 @@ export interface IRtcEngineEventHandler {
* The remote user stops sending the video stream and re-sends it after 15 seconds. Reasons for such an interruption include:
* The remote user leaves the channel.
* The remote user drops offline.
* The remote user calls muteLocalVideoStream to stop sending the video stream.
* The remote user calls disableVideo to disable video.
*
* @param connection The connection information. See RtcConnection.
Expand Down Expand Up @@ -4763,8 +4762,8 @@ export abstract class IRtcEngine {
* The SDK defaults to enabling low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side, which means the sender does not actively send low-quality video stream. The receiver can initiate a low-quality video stream request by calling setRemoteVideoStreamType, and the sender then automatically starts sending low-quality video stream upon receiving the request.
* If you want to modify this behavior, you can call this method and set mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).
* If you want to restore the default behavior after making changes, you can call this method again with mode set to AutoSimulcastStream. The difference and connection between this method and enableDualStreamMode is as follows:
* When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling and setting enabled to false.
* When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling and setting enabled to true.
* When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling enableDualStreamMode and setting enabled to false.
* When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling enableDualStreamMode and setting enabled to true.
* Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
*
* @param mode The mode in which the video stream is sent. See SimulcastStreamMode.
Expand Down Expand Up @@ -5016,15 +5015,7 @@ export abstract class IRtcEngine {
abstract adjustUserPlaybackSignalVolume(uid: number, volume: number): number;

/**
* Sets the fallback option for the published video stream based on the network conditions.
*
* An unstable network affects the audio and video quality in a video call or interactive live video streaming. If option is set as StreamFallbackOptionAudioOnly (2), the SDK disables the upstream video but enables audio only when the network conditions deteriorate and cannot support both video and audio. The SDK monitors the network quality and restores the video stream when the network conditions improve. When the published video stream falls back to audio-only or when the audio-only stream switches back to the video, the SDK triggers the callback.
* In stream push scenarios, set the local push fallback to StreamFallbackOptionAudioOnly (2) may result n some delay for remote CDN users to hear the sound. In this case, Agora recommends that you do not enable this option.
* Ensure that you call this method before joining a channel.
*
* @returns
* 0: Success.
* < 0: Failure.
* @ignore
*/
abstract setLocalPublishFallbackOption(option: StreamFallbackOptions): number;

Expand Down Expand Up @@ -5987,8 +5978,7 @@ export abstract class IRtcEngine {
/**
* Adds event handlers
*
* The SDK uses the IRtcEngineEventHandler class to send callbacks to the app. The app inherits the methods of this class to receive these callbacks. All methods in this class have default (empty) implementations. Therefore, apps only need to inherits callbacks according to the scenarios. In the callbacks, avoid time-consuming tasks or calling APIs that can block the thread, such as the sendStreamMessage method.
* Otherwise, the SDK may not work properly.
* The SDK uses the IRtcEngineEventHandler class to send callbacks to the app. The app inherits the methods of this class to receive these callbacks. All methods in this class have default (empty) implementations. Therefore, apps only need to inherits callbacks according to the scenarios. In the callbacks, avoid time-consuming tasks or calling APIs that can block the thread, such as the sendStreamMessage method. Otherwise, the SDK may not work properly.
*
* @param eventHandler Callback events to be added. See IRtcEngineEventHandler.
*
Expand Down Expand Up @@ -6090,8 +6080,7 @@ export abstract class IRtcEngine {
* Sends data stream messages to all users in a channel. The SDK has the following restrictions on this method:
* Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.
* Each client can send up to 6 KB of data per second.
* Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message.
* A failed method call triggers the onStreamMessageError callback on the remote client.
* Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the onStreamMessageError callback on the remote client.
* Ensure that you call createDataStream to create a data channel before calling this method.
* In live streaming scenarios, this method only applies to hosts.
*
Expand Down
3 changes: 1 addition & 2 deletions src/IAgoraRtcEngineEx.ts
Original file line number Diff line number Diff line change
Expand Up @@ -520,8 +520,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
* After calling createDataStreamEx, you can call this method to send data stream messages to all users in the channel. The SDK has the following restrictions on this method:
* Up to 60 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.
* Each client can send up to 30 KB of data per second.
* Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message.
* A failed method call triggers the onStreamMessageError callback on the remote client.
* Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the onStreamMessageError callback on the remote client.
* Ensure that you call createDataStreamEx to create a data channel before calling this method.
* This method applies only to the COMMUNICATION profile or to the hosts in the LIVE_BROADCASTING profile. If an audience in the LIVE_BROADCASTING profile calls this method, the audience may be switched to a host.
*
Expand Down

0 comments on commit 249d92d

Please sign in to comment.