Skip to content

Commit

Permalink
Merge branch 'master' of github.com:AgoraIO/agora_doc_source
Browse files Browse the repository at this point in the history
  • Loading branch information
Suri539 committed Nov 29, 2024
2 parents c56d48b + 04da5b1 commit 5064563
Show file tree
Hide file tree
Showing 189 changed files with 744 additions and 1,062 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int registerAudioFrameObserver(IAudioFrameObserver observer);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract registerAudioFrameObserver(observer:IAudioFrameObserver):number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setAudioFrameDelegate:(id&lt;AgoraAudioFrameDelegate&gt; _Nullable)delegate;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerAudioFrameObserver(IAudioFrameObserver* observer) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int registerVideoFrameObserver(IVideoFrameObserver observer);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract registerVideoFrameObserver(observer:IVideoFrameObserver):number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setVideoFrameDelegate:(id&lt;AgoraVideoFrameDelegate&gt; _Nullable)delegate;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerVideoFrameObserver(IVideoFrameObserver* observer) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int adjustPlayoutVolume(int volume);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract adjustPlayoutVolume(vol: number): number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)adjustPlayoutVolume:(int)volume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int adjustPlayoutVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int adjustPublishSignalVolume(int volume);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract adjustPublishSignalVolume(volume:number):number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)adjustPublishSignalVolume:(int)volume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int adjustPublishSignalVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">long getDuration();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getDuration():number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)getDuration;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getDuration(int64_t&amp; duration) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getMediaPlayerId();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getMediaPlayerId():number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getMediaPlayerId;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getMediaPlayerId() const = 0; </codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">boolean getMute();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getMute(): boolean;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (bool)getMute;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getMute(bool&amp; mute) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getPlayoutVolume();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPlayoutVolume():number</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getPlayoutVolume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPlayoutVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">long getPlayPosition();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPlayPosition():number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)getPosition;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPlayPosition(int64_t&amp; pos) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">String getPlaySrc();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPlaySrc():string;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSString *)getPlaySrc;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual const char* getPlaySrc() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getPublishSignalVolume();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPublishSignalVolume():number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getPublishSignalVolume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPublishSignalVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getstate.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">Constants.MediaPlayerState getState();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getState():Constants.MediaPlayerState;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (AgoraMediaPlayerState)getPlayerState;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual media::base::MEDIA_PLAYER_STATE getState() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getStreamCount();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getStreamCount():number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)getStreamCount;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getStreamCount(int64_t&amp; count) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">MediaStreamInfo getStreamInfo(int index);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getStreamInfo(index:number):MediaStreamInfo|undefined;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (AgoraMediaStreamInfo *_Nullable)getStreamByIndex:(int)index;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getStreamInfo(int64_t index, media::base::PlayerStreamInfo* info) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int mute(boolean muted);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract mute(muted:boolean) : number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)mute:(bool)isMute NS_SWIFT_NAME(mute(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int mute(bool muted) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_open.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int open(String url, long startPos);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract open(url:string, startPos:number):number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)open:(NSString *)url startPos:(NSInteger)startPos;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int open(const char* url, int64_t startPos) = 0;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int openWithMediaSource(MediaPlayerSource source);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract openWithMediaSource(source: MediaPlayerSource) :number ;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)openWithMediaSource:(AgoraMediaSource *)source;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int openWithMediaSource(const media::base::MediaSource &amp;source) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int pause();
</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract pause(): number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)pause;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int pause() = 0;</codeblock>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_play.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int play();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract play(): number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)play;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int play() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int playPreloadedSrc(String src);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract playPreloadedSrc(src:string):number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)playPreloadedSrc:(NSString *)src;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int playPreloadedSrc(const char* src) = 0;
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int preloadSrc(String src, long startPos);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract preloadSrc(src:string, startPos:number):number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)preloadSrc:(NSString *)src startPos:(int)startPos;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int preloadSrc(const char* src, int64_t startPos) = 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int registerAudioFrameObserver(IMediaPlayerAudioFrameObserver audioFrameObserver, int mode);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract registerAudioFrameObserver(observer:IAudioFrameObserver):number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode) = 0;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int registerPlayerObserver(IMediaPlayerObserver playerObserver);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract registerPlayerObserver(playerObserver:IMediaPlayerObserver);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerPlayerSourceObserver(IMediaPlayerSourceObserver* observer) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintPure, Category = &quot;Agora|IRtcEngine&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract registerVideoFrameObserver(observer:IVideoFrameObserver):number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int resume();</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract resume(): number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)resume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int resume() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int seek(long newPos);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract seek(newPos: number): number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (void)seekToPosition:(NSInteger)position;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int seek(int64_t newPos) = 0;</codeblock>
Expand Down
Loading

0 comments on commit 5064563

Please sign in to comment.