LocalVideoTrack
LocalVideoTrack 是本地視頻軌道的基礎(chǔ)類(lèi)，提供了本地視頻軌道的主要功能。
繼承自:LocalTrack
屬性列表
屬性 | 類(lèi)型 | 描述 | 支持的最低版本 |
isPlaying | boolean | 媒體軌道是否正在播放 | 3.0.0 |
trackMediaType | 媒體軌道類(lèi)型 | 3.0.0 | |
enabled | boolean | 本地軌道當(dāng)前的啟用狀態(tài)。 | 3.0.0 |
muted | boolean | 是否 mute | 3.0.0 |
接口列表
接口 | 描述 | 支持的最低版本 |
獲取當(dāng)前渲染的視頻幀數(shù)據(jù) | 3.0.0 | |
獲取媒體軌道 | 3.0.0 | |
獲取流軌道 id | 3.0.0 | |
在頁(yè)面上播放媒體軌道 | 3.0.0 | |
替換音視頻軌道 | 3.0.0 | |
停止播放 | 3.0.0 | |
取消一個(gè)指定事件的監(jiān)聽(tīng)回調(diào)函數(shù) | 3.0.0 | |
監(jiān)聽(tīng)一個(gè)指定事件并設(shè)置回調(diào)函數(shù) | 3.0.0 | |
監(jiān)聽(tīng)一個(gè)指定事件一次，回調(diào)函數(shù)觸發(fā)后移除 | 3.0.0 | |
取消該對(duì)象指定事件或所有事件上的監(jiān)聽(tīng)回調(diào) | 3.0.0 |
接口詳情
getCurrentFrameData()
只有在播放后才能調(diào)用此方法，如果沒(méi)有調(diào)用 play 則返回空數(shù)據(jù)
獲取當(dāng)前渲染的視頻幀數(shù)據(jù)
類(lèi)型簽名
getCurrentFrameData(): string;
返回
'image/png' 類(lèi)型的 dataURL
getMediaStreamTrack()
獲取媒體軌道
類(lèi)型簽名
getMediaStreamTrack(): MediaStreamTrack;
返回
MediaStreamTrack
媒體軌道
getTrackId()
獲取流軌道 id
類(lèi)型簽名
getTrackId(): string;
返回
string
流軌道 id
play()
在頁(yè)面上播放媒體軌道
類(lèi)型簽名
play(element?: string | HTMLElement, config?: VideoPlayerConfig): void;
參數(shù)
參數(shù) | 類(lèi)型 | 描述 |
element | string | HTMLElement | (Optional)指定一個(gè) DOM 元素，SDK 將在這個(gè)元素下創(chuàng)建video元素播放視頻軌道，支持 2 種類(lèi)型 - string: 指定該 DOM 元素的 ID 值。 - HTMLElement: 直接傳入一個(gè) DOM 元素對(duì)象。 |
config | (Optional)視頻媒體播放參數(shù) |
返回
void
replaceTrack()
替換音視頻軌道
類(lèi)型簽名
replaceTrack(track: MediaStreamTrack, stopOldTrack?: boolean): void;
參數(shù) | 類(lèi)型 | 描述 |
track | MediaStreamTrack | 音視頻軌道 |
stopOldTrack | boolean | (Optional)是否停止上一個(gè)軌道 |
返回
void
stop()
停止播放
類(lèi)型簽名
stop(): void;
返回
void
close()
關(guān)閉本地軌道，并釋放相關(guān)采集設(shè)備。
一旦本地軌道被關(guān)閉，就無(wú)法再次使用。如需再次使用本地軌道，需要重新創(chuàng)建。
類(lèi)型簽名
close(): void;
返回
void
getTrackLabel()
獲取本地軌道的來(lái)源描述
類(lèi)型簽名
getTrackLabel(): string;
返回
string
音頻或視頻軌道描述
setDevice()
更新設(shè)置軌道使用的媒體設(shè)備
類(lèi)型簽名
setDevice(deviceId: string): Promise<void>;
參數(shù)
參數(shù) | 參數(shù) | 描述 |
deviceId | string | 設(shè)備 id |
返回
Promise<void>
setEnabled()
啟用/禁用該軌道。
軌道禁用后，播放和發(fā)布都將被停止，如果該軌道已發(fā)布，調(diào)用 setEnabled后，遠(yuǎn)端會(huì)觸發(fā) user-info-updated 事件。
類(lèi)型簽名
setEnabled(enabled: boolean): Promise<void>;
參數(shù)
參數(shù) | 參數(shù) | 描述 |
enabled | boolean | 是否啟用該軌道 - true: 啟用該軌道。 - false: 禁用該軌道。 |
返回
Promise<void>
setMuted()
發(fā)送或暫停發(fā)送該軌道的媒體數(shù)據(jù)。
如果該軌道已發(fā)布，調(diào)用 setMuted后，遠(yuǎn)端會(huì)觸發(fā) user-info-updated 事件。
類(lèi)型簽名
setMuted(muted: boolean): Promise<void>;
參數(shù)
參數(shù) | 參數(shù) | 描述 |
muted | boolean | 發(fā)送或暫停發(fā)送該軌道的媒體數(shù)據(jù) - true: 發(fā)送媒體數(shù)據(jù) - false: 暫停發(fā)送媒體數(shù)據(jù) |
返回
Promise<void>
on()
監(jiān)聽(tīng)一個(gè)指定事件并設(shè)置回調(diào)函數(shù)
類(lèi)型簽名
on(event: string, fn: Function): void;
參數(shù)
參數(shù) | 類(lèi)型 | 描述 |
event | string | 監(jiān)聽(tīng)的指定事件 |
fn | Function | 監(jiān)聽(tīng)事件觸發(fā)時(shí)的回調(diào)函數(shù) |
返回
void
off()
取消一個(gè)指定事件的監(jiān)聽(tīng)回調(diào)函數(shù)
類(lèi)型簽名
off(event: string, fn: Function): void;
參數(shù)
參數(shù) | 類(lèi)型 | 描述 |
event | string | 監(jiān)聽(tīng)的指定事件 |
fn | Function | 監(jiān)聽(tīng)事件觸發(fā)時(shí)的回調(diào)函數(shù) |
返回
void
once()
監(jiān)聽(tīng)一個(gè)指定事件一次，回調(diào)函數(shù)觸發(fā)后移除
類(lèi)型簽名
once(event: string, fn: Function): void;
參數(shù)
參數(shù) | 類(lèi)型 | 描述 |
event | string | 監(jiān)聽(tīng)的指定事件 |
fn | Function | 監(jiān)聽(tīng)事件觸發(fā)時(shí)的回調(diào)函數(shù) |
返回
void
removeAllListeners()
取消該對(duì)象指定事件或所有事件上的監(jiān)聽(tīng)回調(diào)
類(lèi)型簽名
removeAllListeners(event?: string): void;
參數(shù)
參數(shù) | 類(lèi)型 | 描述 |
event | string | (Optional)設(shè)置了指定事件時(shí)，對(duì)應(yīng)監(jiān)聽(tīng)回調(diào)函數(shù)將會(huì)清空。當(dāng)參數(shù)未填寫(xiě)時(shí)，對(duì)象的所有事件的監(jiān)聽(tīng)函數(shù)都將清空 |
返回
void