Skip to content

Commit

Permalink
[AUTO] Generate codes by terra (#1203)
Browse files Browse the repository at this point in the history
Co-authored-by: guoxianzhe <[email protected]>
  • Loading branch information
sda-rob and guoxianzhe authored Jun 21, 2024
1 parent cfb61b4 commit 72c9555
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 72 deletions.
7 changes: 3 additions & 4 deletions ts/Private/AgoraBase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ export enum QualityType {
*/
QualityDown = 6,
/**
* 7: Users cannot detect the network quality (not in use).
* @ignore
*/
QualityUnsupported = 7,
/**
Expand Down Expand Up @@ -3333,7 +3333,6 @@ export enum ConnectionChangedReasonType {
* All lowercase English letters: a to z.
* All uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
*/
ConnectionChangedInvalidChannelName = 7,
Expand Down Expand Up @@ -3552,15 +3551,15 @@ export enum VideoViewSetupMode {
*/
export class VideoCanvas {
/**
* The user ID.
* User ID that publishes the video source.
*/
uid?: number;
/**
* Reserved for future use.
*/
subviewUid?: number;
/**
* The video display window. In one VideoCanvas, you can only choose to set either view or surfaceTexture. If both are set, only the settings in view take effect.
* The video display window.
*/
view?: any;
/**
Expand Down
2 changes: 1 addition & 1 deletion ts/Private/AgoraMediaBase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1341,7 +1341,7 @@ export interface IAudioSpectrumObserver {
/**
* Gets the statistics of a local audio spectrum.
*
* After successfully calling registerAudioSpectrumObserver to implement the onLocalAudioSpectrum callback in IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
* After successfully calling registerAudioSpectrumObserver to implement the onLocalAudioSpectrum callback in IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK triggers this callback as the time interval you set to report the received remote audio data spectrum before encoding.
*
* @param data The audio spectrum data of the local user. See AudioSpectrumData.
*/
Expand Down
6 changes: 3 additions & 3 deletions ts/Private/IAgoraMediaEngine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export abstract class IMediaEngine {
*
* Before calling this method to push external audio data, perform the following steps:
* Call createCustomAudioTrack to create a custom audio track and get the audio track ID.
* Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
* Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
*
* @param frame The external audio frame. See AudioFrame.
* @param trackId The audio track ID. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
Expand Down Expand Up @@ -195,15 +195,15 @@ export abstract class IMediaEngine {
*
* Ensure that you call this method before joining a channel. To publish a custom audio source, see the following steps:
* Call this method to create a custom audio track and get the audio track ID.
* Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
* Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
* Call pushAudioFrame and specify trackId as the audio track ID set in step 2. You can then publish the corresponding custom audio source in the channel.
*
* @param trackType The type of the custom audio track. See AudioTrackType. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
* @param config The configuration of the custom audio track. See AudioTrackConfig.
*
* @returns
* If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.
* If the method call fails, a negative value is returned.
* If the method call fails, 0xffffffff is returned.
*/
abstract createCustomAudioTrack(
trackType: AudioTrackType,
Expand Down
Loading

0 comments on commit 72c9555

Please sign in to comment.