目錄
本地攝像頭視頻軌道,繼承于 LocalVideoTrack,并在此基礎上提供了更換采集設備/調整編碼參數的功能。
屬性列表
屬性 | 類型 | 描述 | 支持的最低版本 |
isPlaying | boolean | 媒體軌道是否正在播放 | 3.0.0 |
trackMediaType | 媒體軌道類型 | 3.0.0 | |
enabled | boolean | 本地軌道當前的啟用狀態。 | 3.0.0 |
muted | boolean | 是否 mute | 3.0.0 |
接口列表
接口 | 描述 | 支持的最低版本 |
更新設置軌道采集數據的媒體設備 | 3.0.0 | |
獲取當前渲染的視頻幀數據 | 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 |
接口詳情
setDevice()
更新設置軌道采集數據的媒體設備
類型簽名
setDevice(deviceId: string): Promise<void>; //移動端可設置為user/environment
返回
void
getCurrentFrameData()
只有在播放后才能調用此方法,如果沒有調用 play 則返回空數據
獲取當前渲染的視頻幀數據
類型簽名
getCurrentFrameData(): string;
返回
'image/png' 類型的 dataURL
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
close()
關閉本地軌道,并釋放相關采集設備。
一旦本地軌道被關閉,就無法再次使用。如需再次使用本地軌道,需要重新創建。
類型簽名
close(): void;
返回
void
getTrackLabel()
獲取本地軌道的來源描述
類型簽名
getTrackLabel(): string;
返回
string
音頻或視頻軌道描述
setDevice()
更新設置軌道使用的媒體設備
類型簽名
setDevice(deviceId: string): Promise<void>;
參數
參數 | 參數 | 描述 |
deviceId | string | 設備 id |
返回
Promise<void>
setEnabled()
啟用/禁用該軌道。
軌道禁用后,播放和發布都將被停止,如果該軌道已發布,調用 setEnabled后,遠端會觸發 user-info-updated 事件。。
類型簽名
setEnabled(enabled: boolean): Promise<void>;
參數
參數 | 參數 | 描述 |
enabled | boolean | 是否啟用該軌道 - true: 啟用該軌道。 - false: 禁用該軌道。 |
返回
Promise<void>
setMuted()
發送或暫停發送該軌道的媒體數據。
如果該軌道已發布,調用 setMuted后,遠端會觸發 user-info-updated 事件。
類型簽名
setMuted(muted: boolean): Promise<void>;
參數
參數 | 參數 | 描述 |
muted | boolean | 發送或暫停發送該軌道的媒體數據 - true: 發送媒體數據 - false: 暫停發送媒體數據 |
返回
Promise<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