遠端軌道對象的基礎類,為遠端音頻軌道 RemoteAudioTrack 和遠端視頻軌道 RemoteVideoTrack 提供一些公共的方法。
屬性列表
屬性 | 類型 | 描述 | 支持的最低版本 |
isPlaying | boolean | 媒體軌道是否正在播放 | 3.0.0 |
trackMediaType | 媒體軌道類型 | 3.0.0 | |
userId | string | 遠端用戶uid | 3.0.0 |
接口列表
接口名稱 | 描述 | 支持的最低版本 |
獲取媒體軌道 | 3.0.0 | |
獲取流軌道 id | 3.0.0 | |
在頁面上播放媒體軌道 | 3.0.0 | |
替換音視頻軌道 | 3.0.0 | |
停止播放 | 3.0.0 | |
取消一個指定事件的監聽回調函數 | 3.0.0 | |
監聽一個指定事件并設置回調函數 | 3.0.0 | |
監聽一個指定事件一次,回調函數觸發后移除 | 3.0.0 | |
取消該對象指定事件或所有事件上的監聽回調 | 3.0.0 |
事件列表
事件 | 事件參數 | 描述 | 支持的最低版本 |
() => void | 音頻或視頻首幀解碼時觸發。 | 3.0.0 |
接口詳情
getMediaStreamTrack()
獲取媒體軌道
類型簽名
getMediaStreamTrack(): MediaStreamTrack;
返回
MediaStreamTrack
媒體軌道
getTrackId()
獲取流軌道 id
類型簽名
getTrackId(): string;
返回
string
流軌道 id
play()
在頁面上播放媒體軌道
類型簽名
play(element?: string | HTMLElement, config?: VideoPlayerConfig): void;
參數
參數 | 類型 | 描述 |
element | string | HTMLElement | (Optional)指定一個 DOM 元素,SDK 將在這個元素下創建video元素播放視頻軌道,支持 2 種類型 - string: 指定該 DOM 元素的 ID 值。 - HTMLElement: 直接傳入一個 DOM 元素對象。 |
config | (Optional)視頻媒體播放參數 |
返回
void
replaceTrack()
替換音視頻軌道
類型簽名
replaceTrack(track: MediaStreamTrack, stopOldTrack?: boolean): void;
參數 | 類型 | 描述 |
track | MediaStreamTrack | 音視頻軌道 |
stopOldTrack | boolean | (Optional)是否停止上一個軌道 |
返回
void
stop()
停止播放
類型簽名
stop(): void;
返回
void
on()
監聽一個指定事件并設置回調函數
類型簽名
on(event: string, fn: Function): void;
參數
參數 | 類型 | 描述 |
event | string | 監聽的指定事件 |
fn | Function | 監聽事件觸發時的回調函數 |
返回
void
off()
取消一個指定事件的監聽回調函數
類型簽名
off(event: string, fn: Function): void;
參數
參數 | 類型 | 描述 |
event | string | 監聽的指定事件 |
fn | Function | 監聽事件觸發時的回調函數 |
返回
void
once()
監聽一個指定事件一次,回調函數觸發后移除
類型簽名
once(event: string, fn: Function): void;
參數
參數 | 類型 | 描述 |
event | string | 監聽的指定事件 |
fn | Function | 監聽事件觸發時的回調函數 |
返回
void
removeAllListeners()
取消該對象指定事件或所有事件上的監聽回調
類型簽名
removeAllListeners(event?: string): void;
參數
參數 | 類型 | 描述 |
event | string | (Optional)設置了指定事件時,對應監聽回調函數將會清空。當參數未填寫時,對象的所有事件的監聽函數都將清空 |
返回
void
事件列表
"first-frame-decoded"
音頻或視頻首幀解碼時觸發。
類型簽名:
'first-frame-decoded': () => void