AliVCSDK 6.8.0
阿里云音视频SDK，为视频开发者提供一站式接入服务
 
载入中...
搜索中...
未找到
Public 成员函数 | 静态 Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.alivc.live.pusher.AlivcLivePushConfig类 参考
直播SDK » 直播推流

「主要API」推流配置 更多...

类 com.alivc.live.pusher.AlivcLivePushConfig 继承关系图:

Public 成员函数

int getVideoFormat ()
 
void setVideoFormat (int videoFormat)
 
int getAudioFormat ()
 
void setAudioFormat (int audioFormat)
 
void setLivePushMode (AlivcLiveMode pushMode)
 
AlivcLiveMode getLivePushMode ()
 
AlivcResolutionEnum getResolution ()
 
void setResolution (AlivcResolutionEnum resolution)
 
String getExtraInfo ()
 
void setExtraInfo (String extraInfo)
 
String getUserName ()
 
void setUserName (String userName)
 
boolean isH5CompatibleMode ()
 
void setH5CompatibleMode (boolean h5CompatibleMode)
 
boolean isEnableDataChannelMessage ()
 
void setEnableDataChannelMessage (boolean enableDataChannelMessage)
 
AlivcLivePushMonitorLevel getMonitorLevel ()
 
void setMonitorLevel (AlivcLivePushMonitorLevel monitorLevel)
 
int getFps ()
 
void setFps (AlivcFpsEnum fps)
 
int getTargetVideoBitrate ()
 
void setTargetVideoBitrate (int targetBitRate)
 
int getMinVideoBitrate ()
 
void setMinVideoBitrate (int minBitrate)
 
int getBFrames ()
 
void setBFrames (int bFrame)
 
AlivcAudioSampleRateEnum getAudioSampleRate ()
 
void setAudioSampleRate (AlivcAudioSampleRateEnum audioSample)
 
int getPreviewOrientation ()
 
void setPreviewOrientation (AlivcPreviewOrientationEnum previewOrientation)
 
int getPreviewRotation ()
 
void setPreviewRotation (AlivcPreviewRotationEnum rotation)
 
int getCameraType ()
 
void setCameraType (AlivcLivePushCameraTypeEnum cameraType)
 
boolean isPreviewMirror ()
 
void setPreviewMirror (boolean mirror)
 
boolean isAudioOnly ()
 
void setAudioOnly (boolean audioOnly)
 
boolean isVideoOnly ()
 
void setVideoOnly (boolean videoOnly)
 
boolean isAutoFocus ()
 
void setAutoFocus (boolean autoFocus)
 
boolean isFocusBySensor ()
 
void setFocusBySensor (boolean focusBySensor)
 
boolean isFlash ()
 
void setFlash (boolean flash)
 
int getSendDataTimeout ()
 
void setSendDataTimeout (int sendDataTimeout)
 
String getPausePushImage ()
 
void setPausePushImage (String path)
 
String getNetworkPoorPushImage ()
 
void setNetworkPoorPushImage (String path)
 
int getInitialVideoBitrate ()
 
void setInitialVideoBitrate (int initialVideoBitrate)
 
int getConnectRetryCount ()
 
void setConnectRetryCount (int connectRetryCount)
 
int getConnectRetryInterval ()
 
void setConnectRetryInterval (int connectRetryInterval)
 
boolean isPushMirror ()
 
void setPushMirror (boolean pushMirror)
 
AlivcEncodeModeEnum getVideoEncodeMode ()
 
void setVideoEncodeMode (AlivcEncodeModeEnum videoEncodeMode)
 
AlivcEncodeType getVideoEncodeType ()
 
void setVideoEncodeType (AlivcEncodeType videoEncodeType)
 
AlivcEncodeModeEnum getAudioEncodeMode ()
 
void setAudioEncodeMode (AlivcEncodeModeEnum audioEncodeMode)
 
int getWidth ()
 
int getHeight ()
 
int getAudioChannels ()
 
void setAudioChannels (AlivcAudioChannelEnum audioChannels)
 
int getVideoEncodeGop ()
 
void setVideoEncodeGop (AlivcVideoEncodeGopEnum videoEncodeGop)
 
int getExposure ()
 
void setExposure (int exposure)
 
void setUseAliPlayerForBGM (boolean useAliPlayerForBGM)
 
boolean useAliPlayerForBGM ()
 
void setEnableNarrowbandHDForScreenPusher (boolean enable)
 
boolean isEnableNarrowbandHDForScreenPusher ()
 
boolean isEnableRTSForInteractiveMode ()
 
void setEnableRTSForInteractiveMode (boolean enableRTSForInteractiveMode)
 
int getMinFps ()
 
void setMinFps (AlivcFpsEnum minFps)
 
AlivcAudioAACProfileEnum getAudioProfile ()
 
void setAudioProfile (AlivcAudioAACProfileEnum audioProfile)
 
int getAudioBitRate ()
 
void setAudioBitRate (int audioBitRate)
 
AlivcAudioSceneModeEnum getAudioSceneMode ()
 
void setAudioSceneMode (AlivcAudioSceneModeEnum audioSceneMode)
 
void setQualityMode (AlivcQualityModeEnum quality)
 
AlivcQualityModeEnum getQualityMode ()
 
Intent getMediaProjectionPermissionResultData ()
 
boolean isEnableBitrateControl ()
 
void setEnableBitrateControl (boolean enableBitrateControl)
 
boolean isEnableAutoResolution ()
 
void setEnableAutoResolution (boolean enableAutoResolution)
 
boolean isExternMainStream ()
 
void setExternMainStream (boolean externMainStream)
 
void setExternMainStream (boolean externMainStream, AlivcImageFormat imageFormat, AlivcSoundFormat soundFormat)
 
AlivcImageFormat getAlivcExternMainImageFormat ()
 
void setAlivcExternMainImageFormat (AlivcImageFormat alivcExternMainImageFormat)
 
AlivcSoundFormat getAlivcExternMainSoundFormat ()
 
void setAlivcExternMainSoundFormat (AlivcSoundFormat soundFormat)
 
AlivcPreviewDisplayMode getPreviewDisplayMode ()
 
void setPreviewDisplayMode (AlivcPreviewDisplayMode displayMode)
 
void setRequireRenderContextNotify (boolean enable)
 
boolean getRequireRenderContextNotify ()
 
void setAudioCaptureWithoutMix (boolean on)
 
boolean getAudioCaptureWithoutMix ()
 
void addWaterMark (String path, float x, float y, float width)
 
void clearWaterMark ()
 
void removeWaterMark (String path)
 
ArrayList< WaterMarkInfo > getWaterMarkInfos ()
 
String toString ()
 

静态 Public 成员函数

static void setMediaProjectionPermissionResultData (Intent mediaProjectionPermissionResultData)
 

静态 Public 属性

static final String CONFIG = "AlivcLivePushConfig"
 

详细描述

「主要API」推流配置

作者
阿里云直播推流SDK
调用示例
mAlivcLivePusher.init(context, mAlivcLivePushConfig);
参见
com.alivc.live.pusher.AlivcLivePusher::init(android.content.Context, com.alivc.live.pusher.AlivcLivePushConfig)

在文件 AlivcLivePushConfig.java 第 43 行定义.

构造及析构函数说明

◆ AlivcLivePushConfig()

com.alivc.live.pusher.AlivcLivePushConfig.AlivcLivePushConfig ( )

在文件 AlivcLivePushConfig.java 第 130 行定义.

成员函数说明

◆ addWaterMark()

void com.alivc.live.pusher.AlivcLivePushConfig.addWaterMark ( String  path,
float  x,
float  y,
float  width 
)

添加水印

起点位置坐标x[0,width) y[0,height)，宽度(0,width]，最多添加3个

参数
path水印图片
x水印左上角x轴位置 相对位置 0～1
y水印右上角y轴位置 相对位置 0～1
width水印显示宽度 相对位置 0～1
弃用:
建议使用AlivcLivePusher->addWaterMark
参见
com.alivc.live.pusher.AlivcLivePusher::addWaterMark(String, float, float, float)

在文件 AlivcLivePushConfig.java 第 1365 行定义.

◆ clearWaterMark()

void com.alivc.live.pusher.AlivcLivePushConfig.clearWaterMark ( )

清除所有贴纸

在文件 AlivcLivePushConfig.java 第 1380 行定义.

◆ getAlivcExternMainImageFormat()

AlivcImageFormat com.alivc.live.pusher.AlivcLivePushConfig.getAlivcExternMainImageFormat ( )

获取自定义音视频推流的自定义图像格式

默认：IMAGE_FORMAT_YUV420P

返回
自定义图像格式
参见
com.alivc.live.pusher.AlivcImageFormat

在文件 AlivcLivePushConfig.java 第 1243 行定义.

◆ getAlivcExternMainSoundFormat()

AlivcSoundFormat com.alivc.live.pusher.AlivcLivePushConfig.getAlivcExternMainSoundFormat ( )

获取自定义音视频推流的自定义音频格式

默认：SOUND_FORMAT_S16

返回
音频格式
参见
com.alivc.live.pusher.AlivcSoundFormat

在文件 AlivcLivePushConfig.java 第 1266 行定义.

◆ getAudioBitRate()

int com.alivc.live.pusher.AlivcLivePushConfig.getAudioBitRate ( )

获取音频比特率

默认：64k

返回
音频比特率

在文件 AlivcLivePushConfig.java 第 1063 行定义.

◆ getAudioCaptureWithoutMix()

boolean com.alivc.live.pusher.AlivcLivePushConfig.getAudioCaptureWithoutMix ( )

是否开启音频混流

默认：false，不开启

返回
开启状态

在文件 AlivcLivePushConfig.java 第 1348 行定义.

◆ getAudioChannels()

int com.alivc.live.pusher.AlivcLivePushConfig.getAudioChannels ( )

获取音频采集声道数

默认：双声道

返回
声道数

在文件 AlivcLivePushConfig.java 第 873 行定义.

◆ getAudioEncodeMode()

AlivcEncodeModeEnum com.alivc.live.pusher.AlivcLivePushConfig.getAudioEncodeMode ( )

获取音频编码模式

默认：软编

返回
音频编码模式
参见
com.alivc.live.pusher.AlivcEncodeModeEnum

在文件 AlivcLivePushConfig.java 第 832 行定义.

◆ getAudioFormat()

int com.alivc.live.pusher.AlivcLivePushConfig.getAudioFormat ( )

在文件 AlivcLivePushConfig.java 第 147 行定义.

◆ getAudioProfile()

AlivcAudioAACProfileEnum com.alivc.live.pusher.AlivcLivePushConfig.getAudioProfile ( )

获取音频编码格式

默认：AAC_LC

返回
音频编码格式
参见
com.alivc.live.pusher.AlivcAudioAACProfileEnum

在文件 AlivcLivePushConfig.java 第 1040 行定义.

◆ getAudioSampleRate()

AlivcAudioSampleRateEnum com.alivc.live.pusher.AlivcLivePushConfig.getAudioSampleRate ( )

获取推流音频采样率

默认：48k

返回
音频采样率
参见
com.alivc.live.pusher.AlivcAudioSampleRateEnum

在文件 AlivcLivePushConfig.java 第 408 行定义.

◆ getAudioSceneMode()

AlivcAudioSceneModeEnum com.alivc.live.pusher.AlivcLivePushConfig.getAudioSceneMode ( )

获取音频场景模式

默认：音乐模式 媒体模式：环境带媒体声音场景优化，环境降噪优化 音乐模式：设置背景音的场景，高保真优化

返回
音频场景模式
参见
com.alivc.live.pusher.AlivcAudioSceneModeEnum

在文件 AlivcLivePushConfig.java 第 1088 行定义.

◆ getBFrames()

int com.alivc.live.pusher.AlivcLivePushConfig.getBFrames ( )

获取B帧个数

返回
B帧个数

在文件 AlivcLivePushConfig.java 第 385 行定义.

◆ getCameraType()

int com.alivc.live.pusher.AlivcLivePushConfig.getCameraType ( )

获取摄像头类型

默认：前置

返回
摄像头类型

在文件 AlivcLivePushConfig.java 第 481 行定义.

◆ getConnectRetryCount()

int com.alivc.live.pusher.AlivcLivePushConfig.getConnectRetryCount ( )

获取重连次数

默认：5

返回
重连次数

在文件 AlivcLivePushConfig.java 第 717 行定义.

◆ getConnectRetryInterval()

int com.alivc.live.pusher.AlivcLivePushConfig.getConnectRetryInterval ( )

获取重连间隔时间

默认：1000ms

返回
重连间隔时间，单位毫秒

在文件 AlivcLivePushConfig.java 第 739 行定义.

◆ getExposure()

int com.alivc.live.pusher.AlivcLivePushConfig.getExposure ( )

获取曝光度

范围：[0,100]

默认：0

返回
曝光度

在文件 AlivcLivePushConfig.java 第 919 行定义.

◆ getExtraInfo()

String com.alivc.live.pusher.AlivcLivePushConfig.getExtraInfo ( )

获取额外的辅助数据

返回
额外信息

在文件 AlivcLivePushConfig.java 第 230 行定义.

◆ getFps()

int com.alivc.live.pusher.AlivcLivePushConfig.getFps ( )

获取视频采集帧率

返回
视频采集帧率

在文件 AlivcLivePushConfig.java 第 326 行定义.

◆ getHeight()

int com.alivc.live.pusher.AlivcLivePushConfig.getHeight ( )

获取视频高度

返回
视频高度

在文件 AlivcLivePushConfig.java 第 862 行定义.

◆ getInitialVideoBitrate()

int com.alivc.live.pusher.AlivcLivePushConfig.getInitialVideoBitrate ( )

获取初始视频编码码率

返回
初始视频编码码率

在文件 AlivcLivePushConfig.java 第 696 行定义.

◆ getLivePushMode()

AlivcLiveMode com.alivc.live.pusher.AlivcLivePushConfig.getLivePushMode ( )

获取推流模式

返回
推流模式
参见
com.alivc.live.annotations.AlivcLiveMode

在文件 AlivcLivePushConfig.java 第 181 行定义.

◆ getMediaProjectionPermissionResultData()

Intent com.alivc.live.pusher.AlivcLivePushConfig.getMediaProjectionPermissionResultData ( )

获取录屏系统intent

返回
录屏系统intent
注解
当前不支持内录

在文件 AlivcLivePushConfig.java 第 1136 行定义.

◆ getMinFps()

int com.alivc.live.pusher.AlivcLivePushConfig.getMinFps ( )

获取采集最小帧率

默认：8

返回
采集最小帧率
参见
com.alivc.live.pusher.AlivcFpsEnum

在文件 AlivcLivePushConfig.java 第 1016 行定义.

◆ getMinVideoBitrate()

int com.alivc.live.pusher.AlivcLivePushConfig.getMinVideoBitrate ( )

获取最小视频编码码率

返回
最小视频编码码率

在文件 AlivcLivePushConfig.java 第 366 行定义.

◆ getMonitorLevel()

AlivcLivePushMonitorLevel com.alivc.live.pusher.AlivcLivePushConfig.getMonitorLevel ( )

获取SDK质量监控等级

返回
质量监控等级
注解
默认：ALL
参见
com.alivc.live.pusher.AlivcLivePushMonitorLevel

在文件 AlivcLivePushConfig.java 第 303 行定义.

◆ getNetworkPoorPushImage()

String com.alivc.live.pusher.AlivcLivePushConfig.getNetworkPoorPushImage ( )

获取推流弱网图片地址

返回
弱网图片地址（sdcard 路径）
注解
建议格式：png格式

在文件 AlivcLivePushConfig.java 第 677 行定义.

◆ getPausePushImage()

String com.alivc.live.pusher.AlivcLivePushConfig.getPausePushImage ( )

获取推流暂停图片地址

返回
暂停图片地址（sdcard 路径）
注解
建议格式：png格式

在文件 AlivcLivePushConfig.java 第 657 行定义.

◆ getPreviewDisplayMode()

AlivcPreviewDisplayMode com.alivc.live.pusher.AlivcLivePushConfig.getPreviewDisplayMode ( )

获取推流预览显示模式

默认：ASPECT_FIT

返回
推流预览显示模式
参见
com.alivc.live.pusher.AlivcPreviewDisplayMode

在文件 AlivcLivePushConfig.java 第 1290 行定义.

◆ getPreviewOrientation()

int com.alivc.live.pusher.AlivcLivePushConfig.getPreviewOrientation ( )

获取推流预览方向

默认：竖屏

返回
推流预览方向

在文件 AlivcLivePushConfig.java 第 431 行定义.

◆ getPreviewRotation()

int com.alivc.live.pusher.AlivcLivePushConfig.getPreviewRotation ( )

获取推流预览角度

此接口提供给非标准android盒子

默认：0

返回
推流预览角度

在文件 AlivcLivePushConfig.java 第 456 行定义.

◆ getQualityMode()

AlivcQualityModeEnum com.alivc.live.pusher.AlivcLivePushConfig.getQualityMode ( )

获取视频质量模式

默认：清晰度优先

返回
视频质量模式
参见
com.alivc.live.pusher.AlivcQualityModeEnum

在文件 AlivcLivePushConfig.java 第 1126 行定义.

◆ getRequireRenderContextNotify()

boolean com.alivc.live.pusher.AlivcLivePushConfig.getRequireRenderContextNotify ( )

是否开启渲染OpenGL上下文回调通知

默认：false，不开启

返回
开启状态
参见
com.alivc.live.pusher.AlivcLivePusherRenderContextListener

在文件 AlivcLivePushConfig.java 第 1326 行定义.

◆ getResolution()

AlivcResolutionEnum com.alivc.live.pusher.AlivcLivePushConfig.getResolution ( )

获取推流分辨率

默认：540p

返回
推流分辨率
参见
com.alivc.live.pusher.AlivcResolutionEnum

在文件 AlivcLivePushConfig.java 第 197 行定义.

◆ getSendDataTimeout()

int com.alivc.live.pusher.AlivcLivePushConfig.getSendDataTimeout ( )

获取RTMP超时时间

默认：3000ms

返回
超时时间，毫秒级

在文件 AlivcLivePushConfig.java 第 636 行定义.

◆ getTargetVideoBitrate()

int com.alivc.live.pusher.AlivcLivePushConfig.getTargetVideoBitrate ( )

获取目标视频编码码率

返回
目标视频编码码率

在文件 AlivcLivePushConfig.java 第 347 行定义.

◆ getUserName()

String com.alivc.live.pusher.AlivcLivePushConfig.getUserName ( )

在文件 AlivcLivePushConfig.java 第 245 行定义.

◆ getVideoEncodeGop()

int com.alivc.live.pusher.AlivcLivePushConfig.getVideoEncodeGop ( )

获取视频编码GOP

默认：2秒

返回
视频编码GOP，单位秒

在文件 AlivcLivePushConfig.java 第 895 行定义.

◆ getVideoEncodeMode()

AlivcEncodeModeEnum com.alivc.live.pusher.AlivcLivePushConfig.getVideoEncodeMode ( )

获取视频编码模式

默认：硬编

返回
视频编码模式
参见
com.alivc.live.pusher.AlivcEncodeModeEnum

在文件 AlivcLivePushConfig.java 第 784 行定义.

◆ getVideoEncodeType()

AlivcEncodeType com.alivc.live.pusher.AlivcLivePushConfig.getVideoEncodeType ( )

获取视频编码器类型

默认：H264

返回
视频编码器类型
参见
com.alivc.live.pusher.AlivcEncodeType

在文件 AlivcLivePushConfig.java 第 808 行定义.

◆ getVideoFormat()

int com.alivc.live.pusher.AlivcLivePushConfig.getVideoFormat ( )

在文件 AlivcLivePushConfig.java 第 139 行定义.

◆ getWaterMarkInfos()

ArrayList< WaterMarkInfo > com.alivc.live.pusher.AlivcLivePushConfig.getWaterMarkInfos ( )

获取所有贴纸

返回
所有贴纸信息
参见
com.alivc.live.pusher.WaterMarkInfo

在文件 AlivcLivePushConfig.java 第 1405 行定义.

◆ getWidth()

int com.alivc.live.pusher.AlivcLivePushConfig.getWidth ( )

获取视频宽度

返回
视频宽度

在文件 AlivcLivePushConfig.java 第 853 行定义.

◆ isAudioOnly()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isAudioOnly ( )

获取是否为纯音频推流

默认：false，非纯音频推流

返回
纯音频推流

在文件 AlivcLivePushConfig.java 第 526 行定义.

◆ isAutoFocus()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isAutoFocus ( )

是否自动聚焦

默认：true

返回
自动聚焦

在文件 AlivcLivePushConfig.java 第 568 行定义.

◆ isEnableAutoResolution()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isEnableAutoResolution ( )

是否开启动态分辨率

默认：false，关闭

返回
动态分辨率开关

在文件 AlivcLivePushConfig.java 第 1179 行定义.

◆ isEnableBitrateControl()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isEnableBitrateControl ( )

是否开启码控

默认：true，开启

返回
码控开启状态

在文件 AlivcLivePushConfig.java 第 1157 行定义.

◆ isEnableDataChannelMessage()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isEnableDataChannelMessage ( )

是否开启 Data Channel 自定义消息通道

返回
true->开启，false->关闭，默认关闭
注意
非互动模式暂不支持该API，调用无任何效果

在文件 AlivcLivePushConfig.java 第 282 行定义.

◆ isEnableNarrowbandHDForScreenPusher()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isEnableNarrowbandHDForScreenPusher ( )

录屏推流场景下，是否打开窄带高清

更低的带宽，更高的清晰度

默认：true

返回
开关状态

在文件 AlivcLivePushConfig.java 第 984 行定义.

◆ isEnableRTSForInteractiveMode()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isEnableRTSForInteractiveMode ( )

互动模式下是否开启RTS推拉裸流(直推&直拉，不同于直播连麦)

返回
true->推拉裸流，false->直播连麦
注意
非互动模式暂不支持该API

在文件 AlivcLivePushConfig.java 第 994 行定义.

◆ isExternMainStream()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isExternMainStream ( )

是否开启外部音视频推流（三方推流）

默认：false，关闭三方推流

返回
外部音视频推流（三方推流）

在文件 AlivcLivePushConfig.java 第 1201 行定义.

◆ isFlash()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isFlash ( )

是否打开闪光灯

默认：false，不打开

返回
是否打开闪光灯

在文件 AlivcLivePushConfig.java 第 614 行定义.

◆ isFocusBySensor()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isFocusBySensor ( )

获取传感器是否对焦

默认：false

返回
传感器对焦

在文件 AlivcLivePushConfig.java 第 590 行定义.

◆ isH5CompatibleMode()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isH5CompatibleMode ( )

是否H5兼容模式（Web连麦互通）

返回
true->兼容H5，false->不兼容H5
注意
非互动模式暂不支持该API，调用无任何效果

在文件 AlivcLivePushConfig.java 第 259 行定义.

◆ isPreviewMirror()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isPreviewMirror ( )

是否预览镜像

默认：false，预览不镜像

返回
是否预览镜像

在文件 AlivcLivePushConfig.java 第 504 行定义.

◆ isPushMirror()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isPushMirror ( )

是否推流镜像

默认：false

返回
推流镜像

在文件 AlivcLivePushConfig.java 第 761 行定义.

◆ isVideoOnly()

boolean com.alivc.live.pusher.AlivcLivePushConfig.isVideoOnly ( )

获取是否为纯视频推流

返回
纯视频推流

在文件 AlivcLivePushConfig.java 第 546 行定义.

◆ removeWaterMark()

void com.alivc.live.pusher.AlivcLivePushConfig.removeWaterMark ( String  path)

移除贴纸

参数
path贴纸路径

在文件 AlivcLivePushConfig.java 第 1390 行定义.

◆ setAlivcExternMainImageFormat()

void com.alivc.live.pusher.AlivcLivePushConfig.setAlivcExternMainImageFormat ( AlivcImageFormat  alivcExternMainImageFormat)

设置自定义音视频推流的自定义图像格式

默认：IMAGE_FORMAT_YUV420P

参见
com.alivc.live.pusher.AlivcImageFormat

在文件 AlivcLivePushConfig.java 第 1254 行定义.

◆ setAlivcExternMainSoundFormat()

void com.alivc.live.pusher.AlivcLivePushConfig.setAlivcExternMainSoundFormat ( AlivcSoundFormat  soundFormat)

设置自定义音视频推流的自定义音频格式

默认：SOUND_FORMAT_S16

参数
soundFormat音频格式
参见
com.alivc.live.pusher.AlivcSoundFormat

在文件 AlivcLivePushConfig.java 第 1278 行定义.

◆ setAudioBitRate()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioBitRate ( int  audioBitRate)

设置音频比特率

默认：64k

参数
audioBitRate音频比特率

在文件 AlivcLivePushConfig.java 第 1074 行定义.

◆ setAudioCaptureWithoutMix()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioCaptureWithoutMix ( boolean  on)

开启音频混流

默认：false，不开启

参数
on是否开启

在文件 AlivcLivePushConfig.java 第 1337 行定义.

◆ setAudioChannels()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioChannels ( AlivcAudioChannelEnum  audioChannels)

设置音频采集声道数

默认：双声道

参数
audioChannels声道数

在文件 AlivcLivePushConfig.java 第 884 行定义.

◆ setAudioEncodeMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioEncodeMode ( AlivcEncodeModeEnum  audioEncodeMode)

设置音频编码模式

默认：软编

参数
audioEncodeMode音频编码模式
参见
com.alivc.live.pusher.AlivcEncodeModeEnum

在文件 AlivcLivePushConfig.java 第 844 行定义.

◆ setAudioFormat()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioFormat ( int  audioFormat)

在文件 AlivcLivePushConfig.java 第 151 行定义.

◆ setAudioOnly()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioOnly ( boolean  audioOnly)

设置纯音频推流

默认：false，非纯音频推流

参数
audioOnly纯音频推流

在文件 AlivcLivePushConfig.java 第 537 行定义.

◆ setAudioProfile()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioProfile ( AlivcAudioAACProfileEnum  audioProfile)

设置音频编码格式

默认：AAC_LC

参数
audioProfile音频编码格式
参见
com.alivc.live.pusher.AlivcAudioAACProfileEnum

在文件 AlivcLivePushConfig.java 第 1052 行定义.

◆ setAudioSampleRate()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioSampleRate ( AlivcAudioSampleRateEnum  audioSample)

设置推流音频采样率

默认：48k

参数
audioSample音频采样率
参见
com.alivc.live.pusher.AlivcAudioSampleRateEnum

在文件 AlivcLivePushConfig.java 第 420 行定义.

◆ setAudioSceneMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setAudioSceneMode ( AlivcAudioSceneModeEnum  audioSceneMode)

设置音频场景模式

默认：音乐模式 媒体模式：环境带媒体声音场景优化，环境降噪优化 音乐模式：设置背景音的场景，高保真优化

参数
audioSceneMode音频场景模式
参见
com.alivc.live.pusher.AlivcAudioSceneModeEnum

在文件 AlivcLivePushConfig.java 第 1102 行定义.

◆ setAutoFocus()

void com.alivc.live.pusher.AlivcLivePushConfig.setAutoFocus ( boolean  autoFocus)

设置自动聚焦

默认：true

参数
autoFocus自动聚焦

在文件 AlivcLivePushConfig.java 第 579 行定义.

◆ setBFrames()

void com.alivc.live.pusher.AlivcLivePushConfig.setBFrames ( int  bFrame)

设置B帧个数

默认：0

参数
bFrameB帧个数

在文件 AlivcLivePushConfig.java 第 396 行定义.

◆ setCameraType()

void com.alivc.live.pusher.AlivcLivePushConfig.setCameraType ( AlivcLivePushCameraTypeEnum  cameraType)

设置摄像头类型

默认：前置

参数
cameraType摄像头类型
参见
com.alivc.live.pusher.AlivcLivePushCameraTypeEnum

在文件 AlivcLivePushConfig.java 第 493 行定义.

◆ setConnectRetryCount()

void com.alivc.live.pusher.AlivcLivePushConfig.setConnectRetryCount ( int  connectRetryCount)

设置重连次数

默认：5

参数
connectRetryCount重连次数

在文件 AlivcLivePushConfig.java 第 728 行定义.

◆ setConnectRetryInterval()

void com.alivc.live.pusher.AlivcLivePushConfig.setConnectRetryInterval ( int  connectRetryInterval)

设置重连间隔时间

默认：1000ms

参数
connectRetryInterval重连间隔时间，单位毫秒

在文件 AlivcLivePushConfig.java 第 750 行定义.

◆ setEnableAutoResolution()

void com.alivc.live.pusher.AlivcLivePushConfig.setEnableAutoResolution ( boolean  enableAutoResolution)

开启动态分辨率

默认：false，关闭动态分辨率

参数
enableAutoResolution动态分辨率开关

在文件 AlivcLivePushConfig.java 第 1190 行定义.

◆ setEnableBitrateControl()

void com.alivc.live.pusher.AlivcLivePushConfig.setEnableBitrateControl ( boolean  enableBitrateControl)

开启码控

默认：true，开启

参数
enableBitrateControl码控开关

在文件 AlivcLivePushConfig.java 第 1168 行定义.

◆ setEnableDataChannelMessage()

void com.alivc.live.pusher.AlivcLivePushConfig.setEnableDataChannelMessage ( boolean  enableDataChannelMessage)

开启 Data Channel 自定义消息通道

参数
enableDataChannelMessage开关，默认关闭
注意
非互动模式暂不支持该API，调用无任何效果

在文件 AlivcLivePushConfig.java 第 292 行定义.

◆ setEnableNarrowbandHDForScreenPusher()

void com.alivc.live.pusher.AlivcLivePushConfig.setEnableNarrowbandHDForScreenPusher ( boolean  enable)

录屏推流场景下，打开窄带高清开关

更低的带宽，更高的清晰度

默认：true

参数
enable是否打开

在文件 AlivcLivePushConfig.java 第 971 行定义.

◆ setEnableRTSForInteractiveMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setEnableRTSForInteractiveMode ( boolean  enableRTSForInteractiveMode)

互动模式下开启RTS推拉裸流(直推&直拉，不同于直播连麦)

参数
enableRTSForInteractiveMode是否推拉裸流
注意
非互动模式暂不支持该API

在文件 AlivcLivePushConfig.java 第 1004 行定义.

◆ setExposure()

void com.alivc.live.pusher.AlivcLivePushConfig.setExposure ( int  exposure)

设置曝光度

范围：[0,100]

默认：0

参数
exposure曝光度

在文件 AlivcLivePushConfig.java 第 932 行定义.

◆ setExternMainStream() [1/2]

void com.alivc.live.pusher.AlivcLivePushConfig.setExternMainStream ( boolean  externMainStream)

开启/关闭输入自定义音视频流（三方推流）

在输入自定义音视频流模式下，SDK不再采集音视频，只保留编码和发送能力。

默认：false，关闭三方推流

参数
externMainStream外部音视频推流（三方推流）

在文件 AlivcLivePushConfig.java 第 1214 行定义.

◆ setExternMainStream() [2/2]

void com.alivc.live.pusher.AlivcLivePushConfig.setExternMainStream ( boolean  externMainStream,
AlivcImageFormat  imageFormat,
AlivcSoundFormat  soundFormat 
)

开启/关闭输入自定义音视频流（三方推流）

在输入自定义音视频流模式下，SDK不再采集音视频，只保留编码和发送能力。

参数
externMainStream外部音视频推流（三方推流）
imageFormat图像格式
soundFormat音频格式
参见
com.alivc.live.pusher.AlivcImageFormat
com.alivc.live.pusher.AlivcSoundFormat

在文件 AlivcLivePushConfig.java 第 1229 行定义.

◆ setExtraInfo()

void com.alivc.live.pusher.AlivcLivePushConfig.setExtraInfo ( String  extraInfo)

设置额外的辅助数据

如用户id，等用于埋点时排查问题

参数
extraInfo额外信息

在文件 AlivcLivePushConfig.java 第 241 行定义.

◆ setFlash()

void com.alivc.live.pusher.AlivcLivePushConfig.setFlash ( boolean  flash)

设置打开闪光灯

默认：false，不打开

参数
flash打开闪光灯

在文件 AlivcLivePushConfig.java 第 625 行定义.

◆ setFocusBySensor()

void com.alivc.live.pusher.AlivcLivePushConfig.setFocusBySensor ( boolean  focusBySensor)

设置传感器对焦

此接口用于提供给部分系统连续自动对焦算法有问题的android盒子

默认：false

参数
focusBySensor传感器对焦

在文件 AlivcLivePushConfig.java 第 603 行定义.

◆ setFps()

void com.alivc.live.pusher.AlivcLivePushConfig.setFps ( AlivcFpsEnum  fps)

设置视频采集帧率

默认：20fps

参数
fps视频采集帧率
参见
com.alivc.live.pusher.AlivcFpsEnum

在文件 AlivcLivePushConfig.java 第 338 行定义.

◆ setH5CompatibleMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setH5CompatibleMode ( boolean  h5CompatibleMode)

设置H5兼容模式（Web连麦互通）

参数
h5CompatibleMode是否兼容H5
注意
非互动模式暂不支持该API，调用无任何效果
警告
互动模式下，如需与Web连麦互通，必须使用H5兼容模式，否则，Web用户查看Native用户将是黑屏。

同一进程下，只能设置一次；如需修改，需要杀进程再设置；

只能在pusher初始化前调用，pusher初始化后调用无效

在文件 AlivcLivePushConfig.java 第 272 行定义.

◆ setInitialVideoBitrate()

void com.alivc.live.pusher.AlivcLivePushConfig.setInitialVideoBitrate ( int  initialVideoBitrate)

设置初始视频编码码率

参数
initialVideoBitrate初始视频编码码率

在文件 AlivcLivePushConfig.java 第 705 行定义.

◆ setLivePushMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setLivePushMode ( AlivcLiveMode  pushMode)

设置推流模式

默认：基础模式

参数
pushMode推流模式
参见
com.alivc.live.annotations.AlivcLiveMode

基础模式：推rtmp流（'rtmp://'开头），或者推rts流（'artc://'开头）

互动模式：推rtc流（'artc://live.aliyun.com/push/'开头）

注解
请于config初始化后最先的位置进行调用

在文件 AlivcLivePushConfig.java 第 169 行定义.

◆ setMediaProjectionPermissionResultData()

static void com.alivc.live.pusher.AlivcLivePushConfig.setMediaProjectionPermissionResultData ( Intent  mediaProjectionPermissionResultData)
static

设置录屏系统intent

参数
mediaProjectionPermissionResultData录屏系统intent
注解
当前不支持内录

在文件 AlivcLivePushConfig.java 第 1146 行定义.

◆ setMinFps()

void com.alivc.live.pusher.AlivcLivePushConfig.setMinFps ( AlivcFpsEnum  minFps)

设置采集最小帧率

默认：8

参数
minFps采集最小帧率
参见
com.alivc.live.pusher.AlivcFpsEnum

在文件 AlivcLivePushConfig.java 第 1028 行定义.

◆ setMinVideoBitrate()

void com.alivc.live.pusher.AlivcLivePushConfig.setMinVideoBitrate ( int  minBitrate)

设置最小视频编码码率

参数
minBitrate最小视频编码码率

在文件 AlivcLivePushConfig.java 第 375 行定义.

◆ setMonitorLevel()

void com.alivc.live.pusher.AlivcLivePushConfig.setMonitorLevel ( AlivcLivePushMonitorLevel  monitorLevel)

设置SDK质量监控等级

针对嵌入式场景，可以指定精简的监控信息

默认：全量上报

参数
monitorLevel质量监控等级
参见
com.alivc.live.pusher.AlivcLivePushMonitorLevel

在文件 AlivcLivePushConfig.java 第 317 行定义.

◆ setNetworkPoorPushImage()

void com.alivc.live.pusher.AlivcLivePushConfig.setNetworkPoorPushImage ( String  path)

设置推流弱网图片地址

参数
path弱网图片地址（sdcard 路径）
注解
建议格式：png格式

在文件 AlivcLivePushConfig.java 第 687 行定义.

◆ setPausePushImage()

void com.alivc.live.pusher.AlivcLivePushConfig.setPausePushImage ( String  path)

设置推流暂停图片地址

参数
path暂停图片地址（sdcard 路径）
注解
建议格式：png格式

在文件 AlivcLivePushConfig.java 第 667 行定义.

◆ setPreviewDisplayMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setPreviewDisplayMode ( AlivcPreviewDisplayMode  displayMode)

设置推流预览显示模式

默认：ASPECT_FIT

参数
displayMode推流预览显示模式
参见
com.alivc.live.pusher.AlivcPreviewDisplayMode

在文件 AlivcLivePushConfig.java 第 1302 行定义.

◆ setPreviewMirror()

void com.alivc.live.pusher.AlivcLivePushConfig.setPreviewMirror ( boolean  mirror)

设置预览镜像

默认：false，预览不镜像

参数
mirror是否预览镜像

在文件 AlivcLivePushConfig.java 第 515 行定义.

◆ setPreviewOrientation()

void com.alivc.live.pusher.AlivcLivePushConfig.setPreviewOrientation ( AlivcPreviewOrientationEnum  previewOrientation)

设置推流预览方向

默认：竖屏

参数
previewOrientation推流预览方向
参见
com.alivc.live.pusher.AlivcPreviewOrientationEnum

在文件 AlivcLivePushConfig.java 第 443 行定义.

◆ setPreviewRotation()

void com.alivc.live.pusher.AlivcLivePushConfig.setPreviewRotation ( AlivcPreviewRotationEnum  rotation)

设置推流预览角度

此接口提供给非标准android盒子

默认：0

参数
rotation推流预览角度
参见
com.alivc.live.pusher.AlivcPreviewRotationEnum

在文件 AlivcLivePushConfig.java 第 470 行定义.

◆ setPushMirror()

void com.alivc.live.pusher.AlivcLivePushConfig.setPushMirror ( boolean  pushMirror)

设置推流镜像

默认：false

参数
pushMirror推流镜像

在文件 AlivcLivePushConfig.java 第 772 行定义.

◆ setQualityMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setQualityMode ( AlivcQualityModeEnum  quality)

设置视频质量模式

默认：清晰度优先

参数
quality视频质量模式
参见
com.alivc.live.pusher.AlivcQualityModeEnum

在文件 AlivcLivePushConfig.java 第 1114 行定义.

◆ setRequireRenderContextNotify()

void com.alivc.live.pusher.AlivcLivePushConfig.setRequireRenderContextNotify ( boolean  enable)

开启渲染OpenGL上下文回调通知

默认：false，不开启

参数
enable是否开启
参见
com.alivc.live.pusher.AlivcLivePusherRenderContextListener

在文件 AlivcLivePushConfig.java 第 1314 行定义.

◆ setResolution()

void com.alivc.live.pusher.AlivcLivePushConfig.setResolution ( AlivcResolutionEnum  resolution)

设置推流分辨率

默认：540P

参数
resolution分辨率，支持180P/240P/360P/480P/540P/720P/1080P，或者自定义分辨率
参见
com.alivc.live.pusher.AlivcResolutionEnum

在文件 AlivcLivePushConfig.java 第 209 行定义.

◆ setSendDataTimeout()

void com.alivc.live.pusher.AlivcLivePushConfig.setSendDataTimeout ( int  sendDataTimeout)

设置RTMP超时时间

默认：3000ms

参数
sendDataTimeout超时时间，毫秒级

在文件 AlivcLivePushConfig.java 第 647 行定义.

◆ setTargetVideoBitrate()

void com.alivc.live.pusher.AlivcLivePushConfig.setTargetVideoBitrate ( int  targetBitRate)

设置目标视频编码码率

参数
targetBitRate目标编码码率

在文件 AlivcLivePushConfig.java 第 356 行定义.

◆ setUseAliPlayerForBGM()

void com.alivc.live.pusher.AlivcLivePushConfig.setUseAliPlayerForBGM ( boolean  useAliPlayerForBGM)

设置背景音乐是否使用阿里播放器来播放

内置播放器支持大部分场景，若有需要特别的格式，可以切换至阿里播放器，需要app添加5.4.1及以上版本的依赖

默认：false，使用内置播放器

参数
useAliPlayerForBGM是否使用阿里播放器

在文件 AlivcLivePushConfig.java 第 945 行定义.

◆ setUserName()

void com.alivc.live.pusher.AlivcLivePushConfig.setUserName ( String  userName)

在文件 AlivcLivePushConfig.java 第 249 行定义.

◆ setVideoEncodeGop()

void com.alivc.live.pusher.AlivcLivePushConfig.setVideoEncodeGop ( AlivcVideoEncodeGopEnum  videoEncodeGop)

设置视频编码GOP

默认：2秒

参数
videoEncodeGop视频编码GOP，单位秒

在文件 AlivcLivePushConfig.java 第 906 行定义.

◆ setVideoEncodeMode()

void com.alivc.live.pusher.AlivcLivePushConfig.setVideoEncodeMode ( AlivcEncodeModeEnum  videoEncodeMode)

设置视频编码模式

默认：硬编

参数
videoEncodeMode视频编码模式
参见
com.alivc.live.pusher.AlivcEncodeModeEnum

在文件 AlivcLivePushConfig.java 第 796 行定义.

◆ setVideoEncodeType()

void com.alivc.live.pusher.AlivcLivePushConfig.setVideoEncodeType ( AlivcEncodeType  videoEncodeType)

设置视频编码器类型

默认：H264

参数
videoEncodeType视频编码器类型
参见
com.alivc.live.pusher.AlivcEncodeType

在文件 AlivcLivePushConfig.java 第 820 行定义.

◆ setVideoFormat()

void com.alivc.live.pusher.AlivcLivePushConfig.setVideoFormat ( int  videoFormat)

在文件 AlivcLivePushConfig.java 第 143 行定义.

◆ setVideoOnly()

void com.alivc.live.pusher.AlivcLivePushConfig.setVideoOnly ( boolean  videoOnly)

设置纯视频推流

默认：false，非纯视频推流

参数
videoOnly纯视频推流

在文件 AlivcLivePushConfig.java 第 557 行定义.

◆ toString()

String com.alivc.live.pusher.AlivcLivePushConfig.toString ( )

在文件 AlivcLivePushConfig.java 第 1410 行定义.

◆ useAliPlayerForBGM()

boolean com.alivc.live.pusher.AlivcLivePushConfig.useAliPlayerForBGM ( )

获取背景音乐是否使用阿里播放器来播放

内置播放器支持大部分场景，若有需要特别的格式，可以切换至阿里播放器，需要app添加5.4.1及以上版本的依赖

默认：false，使用内置播放器

返回
是否使用阿里播放器

在文件 AlivcLivePushConfig.java 第 958 行定义.

类成员变量说明

◆ CONFIG

final String com.alivc.live.pusher.AlivcLivePushConfig.CONFIG = "AlivcLivePushConfig"
static

在文件 AlivcLivePushConfig.java 第 44 行定义.