YMFLiveAPI (yyvideolib 200.2.9.14.2 API)

java.lang.Object
- com.yy.mediaframework.YMFLiveAPI

All Implemented Interfaces:: IEncoderListener, IYMFPreviewListener

public class YMFLiveAPI
extends java.lang.Object
implements IEncoderListener, IYMFPreviewListener

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class YMFLiveAPI.VideoPublishInfoEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`YMFLiveAPI.VideoPublishInfoEnum`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPreviewFrameCallback(PreviewFrameCallback callback)` 设置获取camera yuv数据回调client（NV21,图像方向以android手机坐标系0度）
`void`	`changeScreenLiveMode(java.lang.Boolean usedBitmap, android.graphics.Bitmap bitmap)` 录屏模式采用固定图片编码推流
`java.lang.String`	`checkCamera()` * 检测前后摄像头
`void`	`destory()` 销毁开播库，还原所有参数
`int`	`getCameraPosition()` 获取当前使用前置还是后置
`static YMFLiveAPI`	`getInstance()`
`VideoEncoderType`	`getVideoPublishEncodeInfo()`
`int`	`getVideoPublishInfo(YMFLiveAPI.VideoPublishInfoEnum infoEnum)` 获取开播信息的帧率，码率，分辨率
`void`	`onEncodeEncParam(java.lang.String param)` sdk内部编码参数通知.
`void`	`onEncodeFirstFrame()` 编码头一帧回调接口.
`void`	`onEncodeFrameData(byte[] data, int len, long pts, long dts, int frameType, VideoEncoderType encodeType, int svcTid, int svcSid)` 编码数据回调接口
`void`	`onEncodeResolution(int width, int height)` 实际编码的分辨率回调接口，每3秒钟回调一次.
`void`	`onEncoderSwitch()` 切换视频编码器
`void`	`onEncodeStat(int bitRate, int frameRate)` 编码码率，帧率统计数据回调接口, 每3秒钟回调一次.
`void`	`onHardEncoderError()` 禁用硬编接口
`void`	`onRenderFirstFrame()` 预览成功回调
`void`	`onWaterMarkSizeChange(int w, int h)` 切换弱网之后，编码分辨率变更，需要变换水印的坐标和宽高
`int`	`pauseVideoCapture(boolean bPauseCapture)` 暂停/恢复摄像头采集，不能用此接口直接开启采集
`void`	`removePreviewFrameCallback(PreviewFrameCallback callback)`
`void`	`requestEncodeIFrame()` 强制编码I帧接口.
`void`	`setAbroadNetWorkStrategy(boolean flag)`
`int`	`setCameraPosition(int position)`
`void`	`setDeltaYYPtsMillions(long deltaPtsDts)` 设置PTS同步矫正, 矫正值根据传输设置，客户端回调到sdk
`void`	`setGPUImageBeautyFilter(IGPUProcess gpuImageProcess)` 由业务实现具体的特效，需要继承GPUImageBeauty抽象类，详情参考GPUImageBeautyOrangeFilter
`int`	`setHardwareEncoderAvailable(boolean available)` 禁用硬编与否接口
`int`	`setLocalVideoCanvas(android.view.SurfaceView view, int renderMode)` Deprecated.
`int`	`setLocalVideoMirrorMode(int mode)` 设置摄像头和编码镜像，只对前置摄像头有效
`void`	`setNetworkBitrateSuggest(int bitrate)` 设置网络传输层建议码率接口.
`void`	`setOriginFrameToEncode(byte[] data, int format, int width, int height, int rotation, long timestamp)` 外部yuv数据推流数据输入接口
`void`	`setOriginTextureToEncode(int inputTexture, int textureTarget, int width, int height, int rotation, long timestamp, float[] transformer)`
`int`	`setPreviewRenderMode(int renderMode)` 设置摄像头预览显示
`void`	`setPublishListener(IPublishListener listener)` 设置YMFLiveApi的监听回调
`int`	`setWatermark(android.graphics.Bitmap bitmap, int offsetX, int offsetY)` 给开播视频打水印
`int`	`startEncodeOrigin()` 开启外部推流源推流编码，只有调用此接口之后输入的数据才能被编码发送
`int`	`startEncodeScreen()` 开启录屏编码
`int`	`startEncodeVideo()` 开启摄像头编码
`int`	`startOriginCapture(boolean useTexture)` 开启外部数据源推流的采集
`int`	`startPreview(android.view.SurfaceView view, int renderMode)` 开启摄像头预览
`int`	`startScreenCapture(android.media.projection.MediaProjection mediaProjection)` 开启录屏采集
`int`	`startVideoCapture()` 开启摄像头采集，当摄像头采集处于停止状态调用此接口能强制开启采集
`int`	`stopEncodeOrigin()` 停止外部推流源推流编码
`int`	`stopEncodeScreen()` 停止录屏编码
`int`	`stopEncodeVideo()` 停止摄像头编码
`int`	`stopOriginCapture()` 关闭外部数据源推流的采集
`int`	`stopPreview()` 停止摄像头预览，并将当前view画面清除
`int`	`stopScreenCapture()` 停止录屏采集
`int`	`stopVideoCapture()` 停止摄像头采集
`boolean`	`updatePublisherConfig(VideoPublisheParam params)` 调用开关采集，开关编码等函数之前，必须先调用此函数为了使开关采集和开关编码无序，所以在此函数中启动gl线程

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static YMFLiveAPI getInstance()
```
  - setPublishListener
```
public void setPublishListener(IPublishListener listener)
```
    设置YMFLiveApi的监听回调
    
    Parameters:
    
    listener - 监听回调
  - destory
```
public void destory()
```
    销毁开播库，还原所有参数
  - updatePublisherConfig
```
public boolean updatePublisherConfig(VideoPublisheParam params)
```
    调用开关采集，开关编码等函数之前，必须先调用此函数为了使开关采集和开关编码无序，所以在此函数中启动gl线程
    
    Parameters:
    
    params -
    
    Returns:
  - startVideoCapture
```
public int startVideoCapture()
```
    开启摄像头采集，当摄像头采集处于停止状态调用此接口能强制开启采集
    
    Returns:
    
    cameraStatue 返回camera状态
  - pauseVideoCapture
```
public int pauseVideoCapture(boolean bPauseCapture)
```
    暂停/恢复摄像头采集，不能用此接口直接开启采集
    
    Parameters:
    
    bPauseCapture - ture 停止采集，false开启采集
    
    Returns:
    
    返回camera状态
  - stopVideoCapture
```
public int stopVideoCapture()
```
    停止摄像头采集
    
    Returns:
  - checkCamera
```
public java.lang.String checkCamera()
```
    * 检测前后摄像头
  - startPreview
```
public int startPreview(android.view.SurfaceView view,
                        int renderMode)
```
    开启摄像头预览
    
    Parameters:
    
    view - 预览相关的surfaceview
    
    renderMode - 预览模式祥见@setPreviewRenderMode
    
    Returns:
  - stopPreview
```
public int stopPreview()
```
    停止摄像头预览，并将当前view画面清除
    
    Returns:
  - startEncodeVideo
```
public int startEncodeVideo()
```
    开启摄像头编码
    
    Returns:
  - stopEncodeVideo
```
public int stopEncodeVideo()
```
    停止摄像头编码
    
    Returns:
  - setLocalVideoMirrorMode
```
public int setLocalVideoMirrorMode(int mode)
```
    设置摄像头和编码镜像，只对前置摄像头有效
    
    Parameters:
    
    mode -
    
    Returns:
  - setCameraPosition
```
public int setCameraPosition(int position)
```
  - setLocalVideoCanvas
```
@Deprecated
public int setLocalVideoCanvas(android.view.SurfaceView view,
                                           int renderMode)
```
    Deprecated.
  - setPreviewRenderMode
```
public int setPreviewRenderMode(int renderMode)
```
    设置摄像头预览显示
    
    Parameters:
    
    renderMode -
    
    Returns:
  - setDeltaYYPtsMillions
```
public void setDeltaYYPtsMillions(long deltaPtsDts)
```
    设置PTS同步矫正, 矫正值根据传输设置，客户端回调到sdk
    
    Parameters:
    
    deltaPtsDts - 单位ms
  - getCameraPosition
```
public int getCameraPosition()
```
    获取当前使用前置还是后置
    
    Returns:
    
    1：前置，0:后置
  - setWatermark
```
public int setWatermark(android.graphics.Bitmap bitmap,
                        int offsetX,
                        int offsetY)
```
    给开播视频打水印
    
    Parameters:
    
    bitmap - 水印图片
    
    offsetX - 水印在视频图像中的位置
    
    offsetY - 水印在视频图像中的位置
    
    Returns:
    
    0：成功；<0：error
  - requestEncodeIFrame
```
public void requestEncodeIFrame()
```
    强制编码I帧接口.
  - setNetworkBitrateSuggest
```
public void setNetworkBitrateSuggest(int bitrate)
```
    设置网络传输层建议码率接口.
    
    Parameters:
    
    bitrate - 建议码率，单位为bps.
  - getVideoPublishInfo
```
public int getVideoPublishInfo(YMFLiveAPI.VideoPublishInfoEnum infoEnum)
```
    获取开播信息的帧率，码率，分辨率
    
    Parameters:
    
    infoEnum - 视频相关的信息，帧率，码率，分辨率
    
    Returns:
    
    帧率，码率，分辨率
  - setHardwareEncoderAvailable
```
public int setHardwareEncoderAvailable(boolean available)
```
    禁用硬编与否接口
    
    Parameters:
    
    available -
    
    Returns:
    
    0：成功；<0：error
  - changeScreenLiveMode
```
public void changeScreenLiveMode(java.lang.Boolean usedBitmap,
                                 android.graphics.Bitmap bitmap)
```
    录屏模式采用固定图片编码推流
    
    Parameters:
    
    usedBitmap - 是否使用bitmap进行推流
    
    bitmap - 推流使用的图片
  - setGPUImageBeautyFilter
```
public void setGPUImageBeautyFilter(IGPUProcess gpuImageProcess)
```
    由业务实现具体的特效，需要继承GPUImageBeauty抽象类，详情参考GPUImageBeautyOrangeFilter
  - addPreviewFrameCallback
```
public void addPreviewFrameCallback(PreviewFrameCallback callback)
```
    设置获取camera yuv数据回调client（NV21,图像方向以android手机坐标系0度）
    
    Parameters:
    
    callback -
  - removePreviewFrameCallback
```
public void removePreviewFrameCallback(PreviewFrameCallback callback)
```
  - startOriginCapture
```
public int startOriginCapture(boolean useTexture)
```
    开启外部数据源推流的采集
    
    Returns:
  - stopOriginCapture
```
public int stopOriginCapture()
```
    关闭外部数据源推流的采集
    
    Returns:
  - startEncodeOrigin
```
public int startEncodeOrigin()
```
    开启外部推流源推流编码，只有调用此接口之后输入的数据才能被编码发送
    
    Returns:
  - stopEncodeOrigin
```
public int stopEncodeOrigin()
```
    停止外部推流源推流编码
    
    Returns:
  - startScreenCapture
```
public int startScreenCapture(android.media.projection.MediaProjection mediaProjection)
```
    开启录屏采集
    
    Parameters:
    
    mediaProjection - android录屏对象
    
    Returns:
  - stopScreenCapture
```
public int stopScreenCapture()
```
    停止录屏采集
    
    Returns:
  - startEncodeScreen
```
public int startEncodeScreen()
```
    开启录屏编码
    
    Returns:
  - stopEncodeScreen
```
public int stopEncodeScreen()
```
    停止录屏编码
    
    Returns:
  - setOriginFrameToEncode
```
public void setOriginFrameToEncode(byte[] data,
                                   int format,
                                   int width,
                                   int height,
                                   int rotation,
                                   long timestamp)
```
    外部yuv数据推流数据输入接口
    
    Parameters:
    
    data - 外部原始图像数据
    
    format - 图像格式 0:rgba，1:i420，2:nv21
    
    width - 图像宽
    
    height - 图像高
    
    rotation - 图像角度 0，90，180，270
    
    timestamp - 当前图像编码的时间戳，必须递增
  - setOriginTextureToEncode
```
public void setOriginTextureToEncode(int inputTexture,
                                     int textureTarget,
                                     int width,
                                     int height,
                                     int rotation,
                                     long timestamp,
                                     float[] transformer)
```
  - onEncodeStat
```
public void onEncodeStat(int bitRate,
                         int frameRate)
```
    Description copied from interface: IEncoderListener
    
    编码码率，帧率统计数据回调接口, 每3秒钟回调一次.
    
    Specified by:
    
    onEncodeStat in interface IEncoderListener
    
    Parameters:
    
    bitRate - 实际编码输出的码率.
    
    frameRate - 实际编码输出的帧率.
  - onEncodeResolution
```
public void onEncodeResolution(int width,
                               int height)
```
    Description copied from interface: IEncoderListener
    
    实际编码的分辨率回调接口，每3秒钟回调一次.
    
    Specified by:
    
    onEncodeResolution in interface IEncoderListener
    
    Parameters:
    
    width - 实际编码分辨率宽度
    
    height - 实际编码分辨率高度.
  - onEncodeFirstFrame
```
public void onEncodeFirstFrame()
```
    Description copied from interface: IEncoderListener
    
    编码头一帧回调接口.
    
    Specified by:
    
    onEncodeFirstFrame in interface IEncoderListener
  - onRenderFirstFrame
```
public void onRenderFirstFrame()
```
    Description copied from interface: IYMFPreviewListener
    
    预览成功回调
    
    Specified by:
    
    onRenderFirstFrame in interface IYMFPreviewListener
  - onEncodeFrameData
```
public void onEncodeFrameData(byte[] data,
                              int len,
                              long pts,
                              long dts,
                              int frameType,
                              VideoEncoderType encodeType,
                              int svcTid,
                              int svcSid)
```
    编码数据回调接口
    
    Specified by:
    
    onEncodeFrameData in interface IEncoderListener
    
    Parameters:
    
    data - 编码后的视频数据
    
    len - 视频数据的长度
    
    pts - 视频数据的pts, 单位是ms
    
    dts - 视频数据的dts, 单位是ms
    
    frameType - 视频数据的帧类型，YY系统中的帧类型取值一样.
    
    encodeType - 视频数据的编码类型，这里是开播SDK中定义的encodeType，特别提醒这里和yysdk中传输定义的encodeType有不同.
    
    svcTid - svc编码专用
    
    svcSid - svc编码专用
  - onEncodeEncParam
```
public void onEncodeEncParam(java.lang.String param)
```
    Description copied from interface: IEncoderListener
    
    sdk内部编码参数通知.
    
    Specified by:
    
    onEncodeEncParam in interface IEncoderListener
    
    Parameters:
    
    param - 编码参数,一般用于调试打印在屏幕，或者统计等等.
  - onHardEncoderError
```
public void onHardEncoderError()
```
    禁用硬编接口
    
    Specified by:
    
    onHardEncoderError in interface IEncoderListener
  - onEncoderSwitch
```
public void onEncoderSwitch()
```
    Description copied from interface: IEncoderListener
    
    切换视频编码器
    
    Specified by:
    
    onEncoderSwitch in interface IEncoderListener
  - onWaterMarkSizeChange
```
public void onWaterMarkSizeChange(int w,
                                  int h)
```
    Description copied from interface: IEncoderListener
    
    切换弱网之后，编码分辨率变更，需要变换水印的坐标和宽高
    
    Specified by:
    
    onWaterMarkSizeChange in interface IEncoderListener
  - getVideoPublishEncodeInfo
```
public VideoEncoderType getVideoPublishEncodeInfo()
```
  - setAbroadNetWorkStrategy
```
public void setAbroadNetWorkStrategy(boolean flag)
```

Class YMFLiveAPI

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

setPublishListener

destory

updatePublisherConfig

startVideoCapture

pauseVideoCapture

stopVideoCapture

checkCamera

startPreview

stopPreview

startEncodeVideo

stopEncodeVideo

setLocalVideoMirrorMode

setCameraPosition

setLocalVideoCanvas

setPreviewRenderMode

setDeltaYYPtsMillions

getCameraPosition

setWatermark

requestEncodeIFrame

setNetworkBitrateSuggest

getVideoPublishInfo

setHardwareEncoderAvailable

changeScreenLiveMode

setGPUImageBeautyFilter

addPreviewFrameCallback

removePreviewFrameCallback

startOriginCapture

stopOriginCapture

startEncodeOrigin

stopEncodeOrigin

startScreenCapture

stopScreenCapture

startEncodeScreen

stopEncodeScreen

setOriginFrameToEncode

setOriginTextureToEncode

onEncodeStat

onEncodeResolution

onEncodeFirstFrame

onRenderFirstFrame

onEncodeFrameData

onEncodeEncParam

onHardEncoderError

onEncoderSwitch

onWaterMarkSizeChange

getVideoPublishEncodeInfo

setAbroadNetWorkStrategy