LocalStream

用户设备采集的本地媒体流。全局单例，通过 create() 方法创建本地媒体流之后，可以通过 getInstance() 方法多次获取本地媒体流实例。

属性

getStreamId()

定义

public long getStreamId()

说明

本地媒体流唯一标识，由服务端生成。

isClosed()

定义

boolean isClosed()

说明

判断当前视频流是否已经关闭,如果没有关闭,可以关闭,并且释放占用资源。

方法

create(options)

定义

public static LocalStream create(LocalStreamOptions options)

说明

创建本地媒体流。

参数

参数名	描述
options	本地媒体流创建配置参数，可以使用默认值进行创建。请参考：LocalStreamOptions

返回值

LocalStream 实例对象。

示例

LocalStreamOptions options = new LocalStreamOptions.Builder().build();
LocalStream localStream = LocalStream.create(options);

getInstance()

定义

public static LocalStream getInstance()

说明

获取已创建的本地媒体流实例对象。

注意：此方法必须在create() 方法调用后使用，如当前未调用 create() 方法进行创建则抛出 NullPointerException 异常。

返回值

LocalStream 实例对象。

示例

localStream = LocalStream.getInstance();

setOnFrameListener()

定义

public void setOnFrameListener(CameraFrameListener listener)

说明

设置相机帧数据获取接口，在回调方法中可以获取视频流的帧数据(目前帧数据格式为 NV21 格式的 byte 数组 )。

参数

参数名	描述
listener	相机帧数据获取接口，请参考：CameraFrameListener

示例

localStream.setOnFrameListener(new LocalStream.CameraFrameListener() {
    @Override
    public void onByteFrame(byte[] bytes, int width, int height) {
        //处理帧数据的方法
        //frameProcess(bytes);
    }
});

switchCamera()

定义

public void switchCamera()

说明

用于前后置摄像头切换。

示例

localStream.switchCamera();

capturePicture(listener, isMirroring)

定义

public void capturePicture(CaptureListener listener, boolean isMirroring)

说明

实现对本地流的拍照功能。

参数

参数名	描述
listener	拍照完成回调接口。
isMirroring	localview 是否设置了镜像。

setFlashMode(flashMode)

定义

public void setFlashMode(FlashMode flashMode)

说明

设置闪光灯模式。

参数

参数名	描述
flashMode	设置闪光灯模式，默认关闭。

attach(videoView)

定义

public void attach(WilddogVideoView videoView)

说明

在指定的 WilddogVideoView 中显示媒体流。

参数

参数名	描述
videoView	请参考：WilddogVideoView。

detach()

定义

public void detach()

说明

解除媒体流与 WilddogVideoView 的绑定，停止播放。

参数

参数名	描述
videoView	请参考：WilddogVideoView。

setAttributes(attributes)

定义

public void setAttributes(Map<String, String> attributes)

说明

用户可以在发流之前设置 localStream 的 attributes，远端用户可以在收到的 remoteStream 中拿到。
注意：此方法以 json 格式传输，传输长度限制在 2048 个字符以内。

参数

参数名	描述
attributes	key 和 value 都为字符串的 Map。

getAttributes()

定义

public Map<String, String> getAttributes()

说明

得到 localStream 的自定义属性，数据类型为 map。

返回值
localStream 对应的自定义属性，数据类型为 map。

close()

定义

void close()

说明

关闭本地流,释放占用资源。

示例

localStream.close();

上次更新：2018-06-21