SimpleWebRTC – API

1.构造函数 new SimpleWebRTC(options)

#url

#socketio

#connection

#debug

#localVideoEl

#remoteVideoEl

#autoRequestMedia

#enableDataChannels

#autoRemoveVideos

#adjustPeerVolume

#peerVolumeWhenSpeaking

#media

#receiveMedia

RTCPeerConnection选项。默认为{ offerToReceiveAudio: 1, offerToReceiveVideo: 1 }

#localVideo

本地视频流选项。默认为{

autoplay: true, // 自动开始video流

mirror: true, // for UX

muted: true // 把video流静音防止回声

}

#logger

2.字段

#capabilities

webrtcSupport对象,表示浏览器支持的功能。

#config

传给构造器的配置选项

#connection

socket信令连接

#webrtc

WebRTC会话。

3.事件

#connectionReady

信令connection触发connect事件时候被触发。

返回session id。

#createdPeer

有三个触发时点

1)加入一个已经存在peers的房间对每一个peer都触发一次(并开始peer)

2)当一个新的peer加入到房间(接收到offer)

3)共享桌面时,对每一个peer都触发一次(并开始peer)

*开始peer,peer.start(), 调用RTCPeerConnection的createOffer,触发并监听offer,送出type=offer的数据。

返回peer,表示一个peer对象,和peer连接相关。

#stunservers

当信令connection触发相同的事件时触发。

返回stunservers参数

#turnservers

当信令connection触发相同的事件时触发。

返回turnservers参数

#localScreenAdded

开始共享桌面被触发时触发该事件。

返回el,包含本地桌面流的元素。

#leftRoom

成功离开当前房间后触发。结束所有peer,并终止本地桌面流。

#videoAdded

增加一个peer流时触发。

返回videoEl,跟增加的流相关联的video元素。peer,跟增加的流相关联的peer

#videoRemoved

移除一个peer流时触发。

返回videoEl,跟移除的流相关联的video元素。peer,跟移除的流相关联的peer

4.方法

#createRoom(name, callback)

在socket连接上触发create事件,并携带name参数。如果提供回调函数的话,在监听处调用该函数。

#joinRoom(name, callback)

在socket连接上触发join事件加入房间name。当socket连接监听join事件时生成roomDescription,回调函数通过callback(err, roomDescription)调用。

#startLocalVideo()

使用media选项开始本地媒体。media选项由构造时传入的config提供。

#testReadiness()

测试socket连接是否已OK并且(本地)媒体流是否已准备好。

都OK的话,触发readyToCall事件。

#mute()

使所有peer的本地音频流静音。(停止传送音频流)

#unmute()

解除所有peer的本地音频流静音。(恢复传送音频流)

#pauseVideo()

对所有peer停止传送视频流。

#resumeVideo()

恢复对所有peer传送视频流。

#pause()

对所有peer停止传送音频流和视频流。

#resume()

恢复对所有peer传送音频流和视频流。

#sendToAll(messageType, payload)

通过信令通道对房间里的所有peer广播一条信息。

messageType:信息的类别key。payload:任意值或对象。

#sendDirectlyToAll(channelLabel, messageType, payload)

通过数据通道对房间里的所有peer广播一条信息。

channelLabel:数据通道的标签。其他参数同sendToAll函数。

#getPeers(sessionId, type)

返回所有指定sessionId和类别的peer。

#shareScreen(callback)

(localmedia)对浏览器发起捕捉桌面请求,成功之后触发localScreen事件。

webrtc监听到该事件之后,对所有类型是video的peer,生成一个类型是screen的peer。

触发localScreenAdded事件,socket连接触发shareScreen事件。

#getLocalScreen

返回本地桌面流。

#stopScreenShare()

停止本地桌面共享流,并从房间里移除该流(peer.end())。

#stopLocalVideo()

停止所有本地媒体流。

#setVolumeForAll(volume)

对所有peer设定音量。

volume,音量,0到1.

#leaveRoom()

离开当前加入的房间,停止所有peer连接和本地桌面共享。

socket连接触发leave事件。

*停止peer:peer.end(),调用RTCPeerConnection.close()

#disconnect()

调用socket连接的disconnect方法,并删除该连接。

内部方法

#handlePeersStreamAdded(peer)

把媒体流关联到DOM上,和一些其他的设定。触发videoAdded事件。

#handlePeerStreamRemoved(peer)

从DOM上删除video容器,触发videoRemoved事件。

#getDomId(peer)

取得和参数peer关联的DOM Id。

#getEl(idOrEl)

取得元素,参数可以是元素或者元素的id。

#getLocalVideoContainer()

取得本地video元素。

#getRemoteVideoContainer()

取得remote video元素。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,837评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,551评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,417评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,448评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,524评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,554评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,569评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,316评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,766评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,077评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,240评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,912评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,560评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,176评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,425评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,114评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,114评论 2 352

推荐阅读更多精彩内容