Skip to content

Commit

Permalink
[AUTO] Generate comments by iris-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Nero-Hu
Nero-Hu authored Jul 21, 2023
1 parent c124912 commit f8d5497
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
4 changes: 2 additions & 2 deletions src/IAgoraMediaPlayer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export abstract class IMediaPlayer {
/**
* Seeks to a new playback position.
*
* fter successfully calling this method, you will receive the onPlayerEvent callback, reporting the result of the seek operation to the new playback position. To play the media file from a specific position, do the following:
* After successfully calling this method, you will receive the onPlayerEvent callback, reporting the result of the seek operation to the new playback position. To play the media file from a specific position, do the following:
* Call this method to seek to the position you want to begin playback.
* Call the play method to play the media file.
*
Expand Down Expand Up @@ -180,7 +180,7 @@ export abstract class IMediaPlayer {
*
* Call this method after calling open.
*
* @param speed The playback speed. Agora recommends that you limit this value to between 50 and 400, defined as follows:
* @param speed The playback speed. Agora recommends that you limit this value to a range between 50 and 400, which is defined as follows:
* 50: Half the original speed.
* 100: The original speed.
* 400: 4 times the original speed.
Expand Down
17 changes: 8 additions & 9 deletions src/IAgoraRtcEngine.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2895,7 +2895,6 @@ export abstract class IRtcEngine {
* @returns
* 0: Success.
* < 0: Failure.
* -2: The parameter is invalid. For example, the token is invalid. You need to pass in a valid parameter and join the channel again.
* -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
* -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.
*/
Expand Down Expand Up @@ -2930,12 +2929,12 @@ export abstract class IRtcEngine {
* The 26 uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
*
* @returns
* 0: Success.
* < 0: Failure.
* -2: The parameter is invalid. For example, an invalid token or User Account is used. You need to pass in a valid parameter and join the channel again.
* -2: The parameter is invalid. For example, the User Account is empty. You need to pass in a valid parameter and join the channel again.
* -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
* -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.
*/
Expand Down Expand Up @@ -2975,7 +2974,7 @@ export abstract class IRtcEngine {
* All uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* @param uid The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 2 32 -1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
* @param options The channel media options. See ChannelMediaOptions.
*
Expand Down Expand Up @@ -6199,7 +6198,7 @@ export abstract class IRtcEngine {
* The 26 uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
*
* @returns
* 0: Success.
Expand All @@ -6220,13 +6219,13 @@ export abstract class IRtcEngine {
* All uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* @param userAccount The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are (89 in total):
* The 26 lowercase English letters: a to z.
* The 26 uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* @param options The channel media options. See ChannelMediaOptions.
*
* @returns
Expand Down Expand Up @@ -6260,13 +6259,13 @@ export abstract class IRtcEngine {
* All uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* @param userAccount The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are (89 in total):
* The 26 lowercase English letters: a to z.
* The 26 uppercase English letters: A to Z.
* All numeric characters: 0 to 9.
* Space
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
* @param options The channel media options. See ChannelMediaOptions.
*
* @returns
Expand Down

0 comments on commit f8d5497

Please sign in to comment.