声网de帮助文档网址

风声之家 2018-02-06

展开全文

声网de帮助文档网址

@param: options.audio if audio is captured locally
@param: options.video if video is captured locally
@param: options.screen if this stream is for screen share
@param: options. extensionId the extension id of your chrome extension if share screen is enabled
return: created local stream
*/
var options = {
    streamID: uid,
    audio: true,
    video: true,
    screen: false,
    //chrome extension id
    extensionId: "minllpmhdgpndnkomcoccfekfegnlikg"
}
var localStream = AgoraRTC.createStream(options);

设置本地流 Profile，详见设置视频属性 (setVideoProfile) 。

//设置本地流视频属性, 详细列表可查看, https://document./cn/2.0/api/web.html#setvideoprofile
/*
stream.setVideoProfile
@param: profile profile string
*/
localStream.setVideoProfile("480p_4");

初始化本地流，详见初始化音视频对象(init) 。

//初始化本地流, 并同时申请本地媒体采集权限
/*
stream.init
@param: callback success callback
*/
localStream.init(function(){
    console.log("Local stream initialized");
});

发布本地流，详见上传本地音视频流 (publish) 。

//发布本地流以使其可以被远端接收到
/*
client.publish
@param: stream the stream to publish
@param: callback failing callback
@return: null
*/
client.publish(localStream, function(err){
    console.log("Publish stream failed", err);
});

监听流事件和订阅远端流，详见远程音视频流已添加回调事件 (stream-added) 和订阅远程音视频流 (subscribe) 。

 //监听流事件
 /*
 client.on
 @param: listen to stream event
 @param: callback listener callback
 @return: null
 @event: stream-added when new stream added to channel
 */

 /*
 client.subscribe
 @param: stream stream to subscribe
 @param: callback failing callback
 @return: null
 */
 client.on('stream-added', function(evt) {
     var stream = evt.stream;
     console.log("New stream added: " + stream.getId());
     console.log("Timestamp: " + Date.now());
     console.log("Subscribe ", stream);
     //在有新的流加入后订阅远端流
     client.subscribe(stream, function(err) {
        console.log("Subscribe stream failed", err);
     });
 });

 /*
 @event: peer-leave when existing stream left the channel
 */
 client.on('peer-leave', function(evt) {
    console.log("Peer has left: " + evt.uid);
    console.log("Timestamp: " + Date.now());
    console.log(evt);
 });

 /*
 @event: stream-subscribed when a stream is successfully subscribed
 */
 client.on('stream-subscribed', function(evt) {
    var stream = evt.stream;
    console.log("Got stream-subscribed event");
    console.log("Timestamp: " + Date.now());
    console.log("Subscribe remote stream successfully: " + stream.getId());
    console.log(evt);
 });

 /*
 @event: stream-removed when a stream is removed
 */
 client.on("stream-removed", function(evt) {
    var stream = evt.stream;
    console.log("Stream removed: " + evt.stream.getId());
    console.log("Timestamp: " + Date.now());
    console.log(evt);
});

播放本地/远端流，详见播放音视频流 (play) 。

//将本地流在id为agora-remote的dom中播放
/*
stream.play
@param: tag the dom tag where you want to play the video
@return: null
*/
localStream.play("agora-remote");

安装好示例代码后，输入你想要进入的房间名，请确保在音视频通话之前开通你的摄像头和麦克风权限。

场景 2 ：网页端屏幕共享

如果想在网页端音视频通话过程中，启用屏幕共享功能，在使用示例代码前，你还需要进行如下操作：

1. 获取屏幕共享插件

联系 sales@agora.io 或技术支持获取 Chrome 屏幕共享插件，并将获取到的插件包解压。完整的插件文件夹结构如下图所示：

2. 安装插件并获取插件 ID

在 Chrome 网页端安装获取到的 Chrome 插件。首先打开你的 Chrome 浏览器，点击屏幕右上方的扩展按钮，选择更多工具 > 扩展程序。

然后点击加载已解压的扩展程序，选择你刚刚获取并解压的 Chrome 插件文件夹，然后点击选择。
完成插件安装后，你可以直接在 Chrome 浏览器界面查看你的插件 ID。

3. 修改域名

点击打开插件文件夹中的 json 文件夹，然后将 match 行的域名替换为你的网页域名。

4. 部署 Sample code

1）创建 Client 对象，详见创建音视频对象 (createClient) 。

//创建 Client 对象
/*
RTC.createClient
@param: appid - appid
@param: callback - success callback
@reurn: rtc client
*/
var client = AgoraRTC.createClient({mode:'interop'});

2）初始化 Client 对象，详见初始化客户端对象 (init) 。

//初始化 Client 对象
/*
client.init
@param: appid - appid
@param: callback - success callback
return: null
*/
client.init(appid, function(){
    console.log("AgoraRTC client initialized");
});

3）加入频道，详见加入 AgoraRTC 频道 (join) 。

//加入频道，如果启用了dynamic key, 请将dynamic key作为第一个参数
//若有自己的用户ID系统, 可在第三个参数传参, 不然可传undefined, 则Agora会自动分配一个uid
/*
client.join
@param: key - dynamic key
@param: channel - channel name
@param: uid - uid, undefined if random one
@param: callback - success callback
return: null
*/
client.join(null, "webtest", undefined, function(uid){
    console.log("User " + uid + " join channel successfully");
    console.log("Timestamp: " + Date.now());
});

4）创建本地流，详见创建音视频流对象 (createStream) 。注意将代码中的 extensionId 替换成刚刚获取的插件 ID，详见 2. 安装插件并获取插件 ID 。

//创建本地流, 设置audio/video为false, screen为true, extensionID请提供属于你自己的chrome分享屏幕插件ID
//共享的流与一般的流几乎没有区别, 拥有一样的事件与生命周期, 但不能用来控制音频或视频
/*
RTC.createStream
@param: options
@param: options.streamId id of stream
@param: options.audio if audio is captured locally
@param: options.video if video is captured locally
@param: options.screen if this stream is for screen share
@param: options. extensionId the extension id of your chrome extension if share screen is enabled
return: created local stream
*/
var options = {
    streamID: uid,
    audio: false,
    video: false,
    screen: true,
    //chrome extension id
    extensionId: "minllpmhdgpndnkomcoccfekfegnlikg"
}
var localStream = AgoraRTC.createStream(options);

5）设置本地流 Profile，详见设置视频属性 (setVideoProfile) 。

//设置本地流视频属性, 详细列表可查看, https://document./cn/1.14/api/web.html#setvideoprofile
/*
stream.setVideoProfile
@param: profile profile string
*/
localStream.setVideoProfile("480p_4");

6）初始化本地流，详见初始化音视频对象(init) 。

//初始化本地流, 并同时申请本地媒体采集权限
/*
stream.init
@param: callback success callback
*/
localStream.init(function(){
    console.log("Local stream initialized");
});

7）发布本地流，详见上传本地音视频流 (publish) 。

//发布本地流以使其可以被远端接收到
/*
client.publish
@param: stream the stream to publish
@param: callback failing callback
@return: null
*/
client.publish(localStream, function(err){
    console.log("Publish stream failed", err);
});

8）监听流事件和订阅远端流，详见远程音视频流已添加回调事件 (stream-added) 和订阅远程音视频流 (subscribe) 。

 //监听流事件
 /*
 client.on
 @param: listen to stream event
 @param: callback listener callback
 @return: null
 @event: stream-added when new stream added to channel
 */

 /*
 client.subscribe
 @param: stream stream to subscribe
 @param: callback failing callback
 @return: null
 */
 client.on('stream-added', function(evt) {
     var stream = evt.stream;
     console.log("New stream added: " + stream.getId());
     console.log("Timestamp: " + Date.now());
     console.log("Subscribe ", stream);
     //在有新的流加入后订阅远端流
     client.subscribe(stream, function(err) {
        console.log("Subscribe stream failed", err);
     });
 });

 /*
 @event: peer-leave when existing stream left the channel
 */
 client.on('peer-leave', function(evt) {
     console.log("Peer has left: " + evt.uid);
     console.log("Timestamp: " + Date.now());
     console.log(evt);
 });

 /*
 @event: stream-subscribed when a stream is successfully subscribed
 */
 client.on('stream-subscribed', function(evt) {
     var stream = evt.stream;
     console.log("Got stream-subscribed event");
     console.log("Timestamp: " + Date.now());
     console.log("Subscribe remote stream successfully: " + stream.getId());
     console.log(evt);
 });

 /*
 @event: stream-removed when a stream is removed
 */
client.on("stream-removed", function(evt) {
    var stream = evt.stream;
    console.log("Stream removed: " + evt.stream.getId());
    console.log("Timestamp: " + Date.now());
    console.log(evt);
});

9）播放本地/远端流，详见播放音视频流 (play) 。

//将本地流在id为agora-remote的dom中播放
/*
stream.play
@param: tag the dom tag where you want to play the video
@return: null
*/
localStream.play("agora-remote");

安装好示例代码后，你就可以开始屏幕共享了。

如果想退出屏幕共享，可以参考如下代码的逻辑：

function deinitShare(client, stream) {
      if (stream) {
         // share stream exist already
         client.unpublish(stream, function (err) {
            console.log("Unpublish failed with error: ", err);
         });
         stream.close();
         client.leave();
       }
     }