设为首页收藏本站
开启辅助访问

百家云

 您所在的位置：网站首页 › 百家云播放器 › 百家云

百家云

2024-07-12 20:48| 来源: 网络整理| 查看: 265

LocalStream 本地音视频流,通过 createStream 创建。

Index Properties streamCodecOption Accessors audioTrack videoTrack Methods init destroy addTrack removeTrack replaceTrack replay fire getAudioDeviceId getAudioLevel getAudioTrack getAudioVolume getStreamId getUserId getAudioOn isLocalStream setAudioProfile setScreenProfile setVideoEncoderConfiguration isScreenStream setVideoProfile getVideoFrame getVideoOn getVideoTrack hasAudio hasVideo isPlaying muteAudio muteVideo resume stop unmuteAudio unmuteVideo off on one play getStats switchDevice getMediaStream Properties

streamCodecOption本地流配置项

localStream.streamCodecOption: streamCodecOption

详情

详见 streamCodecOption Accessors

audioTrack本地音频轨道

localStream.audioTrack(): MediaStreamTrack

返回

MediaStreamTrack

videoTrack本地视频轨道

localStream.videoTrack(): MediaStreamTrackMediaStreamTrack

返回

MediaStreamTrack Methods

init初始化 LocalStream 实例

localStream.init(): Promise

返回

Promise

destroy销毁音视频流

localStream.destroy():void

返回

void

addTrack添加音频或视频轨道

localStream.addTrack(track: MediaStreamTrack): Promise

返回

Promise

详情

调用该方法将音频或视频轨道添加到本地流，若该本地流已经被发布，则会自动更新发往远端的音视频流，此时远端会收到 Client.on('stream-updated') 事件通知 请注意，一个 Stream 对象中最多只能同时包含一路音频轨道和一路视频轨道。如果你想要更换同类型的轨道，请使用 replaceTrack() 新的音视频轨道可以通过 createStream/getAudioTrack|getVideoTrack 获取， 或者直接通过 getUserMedia、captureStream 获取

removeTrack移除视频轨道

localStream.removeTrack(track: MediaStreamTrack): Promise

返回

Promise

详情

调用该方法会移除本地流中的视频轨道，若本地流已经被发布，则会自动更新发往远端的视频流，此时远端会收到 Client.on('stream-updated') 事件通知 请注意，一个已经发布的Stream对象中至少要有一个媒体轨道，如果你想完全删除本地流中的音视频轨道，请直接通过 unpublish 取消发布， 然后再通过 destroy 关闭本地流

replaceTrack更换音频或视频轨道

localStream.replaceTrack(track: MediaStreamTrack): Promise

返回

Promise

详情

调用该方法更换本地流中的同类型轨道,若本地流已经被发布,该方法会自动更新发往远端的音视频流,此时远端会收到 Client.on('stream-updated') 事件通知 在更换视频轨道时,要求视频分辨率跟 setVideoProfile设置保持一致,否则会抛出异常 支持 Chrome 65+、Safari 浏览器

replay重新播放流

localStream.replay(): Promise

返回

Promise

fire提交事件

localStream.fire(类型: string, data: any):void

参数

名称 类型 描述 type string 事件类型 Optional data any 事件数据

返回

void

getAudioDeviceId获取当前播放的扬声器设备id

localStream.getAudioDeviceId():string

返回

string

getAudioLevel获取当前音量大小

localStream.getAudioLevel():number

返回

number

详情

只有当本地流或远端流中有音频数据才有效 返回值在(0.0, 1.0)之间,通常认为值大于0.1为用户正在说话

getAudioTrack获取音频轨道

localStream.getAudioTrack():MediaStreamTrack

返回

MediaStreamTrack

getAudioVolume获取当前播放音量

localStream.getAudioVolume():number

返回

number

getStreamId获取 stream id

localStream.getStreamId():string

返回

string

getUserId获取 userId

localStream.getUserId(): string

返回

string

getAudioOn获取流音频是否挂起

localStream.getAudioOn(): boolean

返回

boolean

isLocalStream判断是否是本地流

localStream.isLocalStream(): boolean

返回

boolean

setAudioProfile设置音频 profile

localStream.setAudioProfile(profile: AudioProfile): void

参数

名称 描述 profile AudioProfile配置项

返回

void

详情

该方法需要在调用 init 之前调用。

setScreenProfile设置屏幕分享 profile

localStream.setScreenProfile(profile: ScreenProfile): void

参数

名称 描述 profile ScreenProfile配置项

返回

void

详情

该方法需要在调用 init 之前调用

setVideoEncoderConfiguration设置自定义视频编码配置

localStream.setVideoEncoderConfiguration(options: StreamCodecOption): void

参数

名称 描述 profile StreamCodecOption配置项

返回

void

详情

该方法可以根据需要灵活设置本地流的视频分辨率、帧率和码率

isScreenStream是否是屏幕分享流

localStream.isScreenStream(): boolean

参数

名称 描述 profile StreamCodecOption配置项

返回

boolean

setVideoProfile设置视频 profile

localStream.setVideoProfile(profile: VideoProfile): void

参数

名称 描述 profile VideoProfile配置项

返回

void

详情

该方法需要在调用 init 之前调用

getVideoFrame截取当前流的一帧视频数据（base64格式的图片)

localStream.getVideoFrame(): string

返回

string

详情

该方法需要在 play 后调用,并且 Stream 中有视频流才有效

getVideoOn获取流视频是否挂起

localStream.getVideoOn(): boolean

返回

boolean

getVideoTrack获取视频轨道

localStream.getVideoTrack(): MediaStreamTrack

返回

MediaStreamTrack

hasAudio是否有音频

localStream.hasAudio(): boolean

返回

boolean

hasVideo是否有本地视频

localStream.hasVideo(): boolean

返回

boolean

isPlaying流是否正在播放

localStream.isPlaying():boolean

返回

boolean

muteAudio禁用音频轨道

localStream.muteAudio():boolean

返回

boolean

详情

对于本地流,调用该方法会停止发送音频,远端会触发 Client.on(‘mute-audio’) 事件 对于远端流,调用该方法会停止播放音频,但是仍然接收音频数据

muteVideo禁用视频轨道

localStream.muteVideo():boolean

返回

boolean

详情

对于本地流,调用该方法会停止发送视频,远端会触发 Client.on(‘mute-video’) 事件 如果视频是从摄像头采集,此时摄像头灯仍然是亮着的 若想完全禁用视频轨道(即关闭摄像头)可以使用 removeTrack() 删除视频轨道然后调用 MediaStreamTrack.stop() 关闭视频轨道（关闭摄像头） 对于远端流,调用该方法会停止播放视频,但是仍然接收视频数据

resume恢复播放音视频

localStream.resume(): void

返回

void

详情

在某些版本浏览器上移动传入 play() 的 div 容器可能会导致音视频播放器进入 ‘PAUSED’ 状态,此时 需要调用该接口恢复播放 由于浏览器自动播放策略的限制,在 play() 返回 PLAY_NOT_ALLOWED 错误后需要引导用户通过手势 调用该接口恢复播放

stop停止播放流

localStream.stop(): void

返回

void

unmuteAudio启用音频轨道

localStream.unmuteAudio(): boolean

返回

boolean

详情

对于本地流,调用该方法会触发远端 Client.on(‘unmute-audio’) 事件 音频轨道默认是开启的,若你调用 muteAudio() 后可用该方法重新启用音频

unmuteVideo启用视频轨道

localStream.unmuteVideo(): boolean

返回

boolean

详情

对于本地流,调用该方法会触发远端 Client.on(‘unmute-video’) 事件 视频轨道默认是开启的,若你调用 muteVideo() 后可用该方法重新启用视频

off取消事件监听

localStream.off(类型: string, fn: Function): this

参数

名称 类型 描述 type string 事件类型 fn Function 事件回调

返回

实例本身Stream

详情

只传 类型 取消此事件的所有监听 不传任何参数取消所有事件的监听

on监听Stream事件

localStream.on(类型: string, fn: Function): this

参数

名称 类型 描述 type string 事件类型 fn Function 事件回调

返回

实例本身Stream

one监听一次事件,执行一次之后自动取消监听

localStream.one(类型: string, fn: Function): this

参数

名称 类型 描述 type string 事件类型 fn Function 事件回调

返回

实例本身Stream

play播放流本地流

localStream.play(videoId: string | HTMLDivElement, options: StreamPlayOption): Promise‹any›

参数

名称 类型 描述 videoId string | HTMLDivElement 挂载Dom Default value options StreamPlayOption 播放选项

返回

Promise‹any›

详情

由于浏览器自动播放策略的影响,调用该接口可能会返回 PLAY_NOT_ALLOWED 错误, 此时需要引导用户通过手势操作调用 resume 恢复音视频播放

getStats获取流的传输信息

localStream.getStats(): Promise

返回

Promise

switchDevice切换媒体输入设备，调用该方法可更换本地流的媒体输入设备

localStream.switchDevice(type: TrackType, deviceId: string): promise

返回

Promise‹any›

getMediaStream获取 MediaStream 实例

localStream.getMediaStream(): MediaStream

返回

Promise


【本文地址】


今日新闻

推荐新闻

CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3