QNLocalVideoTrack
Hierarchy
Index
Properties
Event
Core Methods
Properties
trackID
- trackID?: string
-
Track ID
对于本地 Track,当且仅当 Track 发布后才可获取到有效的 TrackID;对于远端 Track,可随时获取到有效的 TrackID。
userID
- userID?: string
-
用户 ID
tag
- tag?: string
-
自定义 tag 文本
mediaElement
- mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
-
当前播放元素,当调用 play 方法后,可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
- isMultiProfileEnabled: boolean
-
是否开启大小流
废弃,请使用 getLowStreamConfig 替代。
Event
ended
- (): void
-
Track 断开
track.on('ended', function() { console.log('ended') })
Core Methods
play
- public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
-
播放当前 track
Parameters-
container: HTMLElement
挂载的 html 容器,SDK 会在该容器下创建 audio 或 video 元素来播放 track
-
Optional config: QNPlayerConfig
播放配置信息
Returns void -
isAudio
- isAudio(): boolean
-
是否是音频
Returns boolean
isVideo
- isVideo(): boolean
-
是否是视频
Returns boolean
isMuted
- isMuted(): boolean
-
是否 mute(静音)
Returns boolean
getMediaStreamTrack
- getMediaStreamTrack(): MediaStreamTrack | undefined
-
获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
- setMuted(isMuted: boolean): void
-
设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端订阅 track 将会收到 mute-state-changed 事件。
Parameters-
isMuted: boolean
是否 mute
Returns void -
destroy
- destroy(): void
-
销毁当前流
Returns void
getLowStreamConfig
- getLowStreamConfig(): QNLowStreamConfig | undefined
-
获取小流配置
大小流使用方法可参考视频大小流使用指南。
Returns QNLowStreamConfig | undefined
getCurrentFrameData
- getCurrentFrameData(): string
-
截取当前视频流画面
Returns string
getStats
- getStats(): QNLocalVideoTrackStats[]
-
获取流状态数据
Returns QNLocalVideoTrackStats
setOptimizationMode
- setOptimizationMode(mode: QNVideoOptimizationMode): boolean
-
设置传输优化模式
Parameters-
mode: QNVideoOptimizationMode
视频优化模式
Returns boolean -
文档反馈
(如有产品使用问题,请 提交工单)