typedef NS_ENUM(
    NSInteger,
    VeLiveVideoEffectLicenseType
)

视频特效的许可证认证方式。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveNetworkQuality
)

网络质量/状态。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveAudioChannel
)

推流音频声道数，决定音频的立体感。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoEncodeFrameType
)

视频编码帧类型，指定视频编码后的帧类型。

枚举值 #

@interface VeLiveVideoEncoderConfiguration : NSObject

推流视频编码参数。

成员变量 #

成员函数 #

变量说明 #

resolution #

@property (nonatomic, assign, readonly) VeLiveVideoResolution resolution;

推流视频分辨率，默认值为 VeLiveVideoResolution720P，详情请参见 VeLiveVideoResolution。

codec #

@property (nonatomic, assign) VeLiveVideoCodec codec;

推流视频编码格式，默认值为 VeLiveVideoCodecH264，详情请参见 VeLiveVideoCodec。

bitrate #

@property (nonatomic, assign) int bitrate;

视频目标编码码率，单位为 kbps，默认值由 resolution 参数值决定。

minBitrate #

@property (nonatomic, assign) int minBitrate;

视频最小编码码率，单位为 kbps，默认值由 resolution 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最小码率。

maxBitrate #

@property (nonatomic, assign) int maxBitrate;

视频最大编码码率，单位为 kbps，默认值由 resolution 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最大码率。

gopSize #

@property (nonatomic, assign) int gopSize;

视频 GOP 大小，单位为 s，默认值为 2。

fps #

@property (nonatomic, assign) int fps;

视频编码帧率，单位为 fps，默认值为 15。

enableBFrame #

@property (nonatomic, assign) BOOL enableBFrame;

是否启用 B 帧，默认值为 NO，支持的取值包括：

• YES：开启；
• NO：关闭。
  

enableAccelerate #

@property (nonatomic, assign) BOOL enableAccelerate;

是否开启硬件编码，默认值为 YES，支持的取值包括：

• YES：开启；
• NO：关闭。

函数说明 #

initWithResolution: #

- (instancetype)initWithResolution:(VeLiveVideoResolution)resolution NS_DESIGNATED_INITIALIZER;

初始化方法，用于创建一个 VeLiveVideoEncoderConfiguration 对象，并指定视频的分辨率。

传入参数

返回值

创建的 VeLiveVideoEncoderConfiguration 对象。

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoFrameSource
)

视频帧来源。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveAudioBufferType
)

推流音频数据类型。

枚举值 #

@interface VeLivePusherConfiguration : NSObject

推流引擎初始化配置。

成员变量 #

变量说明 #

videoCaptureConfig #

@property (nonatomic, strong, nullable) VeLiveVideoCaptureConfiguration *videoCaptureConfig;

视频采集参数设置，用于调整和设置视频采集相关的参数。详情请参见 VeLiveVideoCaptureConfiguration。

audioCaptureConfig #

@property (nonatomic, strong, nullable) VeLiveAudioCaptureConfiguration *audioCaptureConfig;

音频采集参数设置，用于调整和设置音频采集相关的参数。详情请参见 VeLiveAudioCaptureConfiguration。

reconnectIntervalSeconds #

@property (nonatomic, assign) int reconnectIntervalSeconds;

推流失败后，尝试重连的时间间隔。单位为 s，默认值为 5。

reconnectCount #

@property (nonatomic, assign) int reconnectCount;

推流失败后，尝试重连的次数。默认值为 3。

extraParameters #

@property (nonatomic, strong) NSDictionary *extraParameters;

设置扩展参数，用于实现某些特殊功能或配置，默认不需要设置。

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoCaptureType
)

视频采集类型。

枚举值 #

@interface VeLiveFileRecorderConfiguration : NSObject

推流端本地文件录制配置。

成员变量 #

变量说明 #

width #

@property (nonatomic, assign) int width;

录制的视频宽度，单位为 px，默认值为 360。

height #

@property (nonatomic, assign) int height;

录制的视频高度，单位为 px，默认值为 640。

fps #

@property (nonatomic, assign) int fps;

录制的视频帧率，默认值为 15，取值范围为 [1,15]。

bitrate #

@property (nonatomic, assign) int bitrate;

录制的视频编码码率，单位为 kbps，默认值为 2000。

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoBufferType
)

推流视频数据类型。

枚举值 #

@interface VeLiveMixVideoLayout : NSObject

视频混流设置。包含视频流 ID、位置、大小、透明度、层级和渲染模式等属性。

成员变量 #

变量说明 #

streamId #

@property (nonatomic, assign) int streamId;

视频流 ID，唯一标识，用于区分不同的视频流。

x #

@property (nonatomic, assign) float x;

视频流对应区域左上角的横坐标，该坐标是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。

y #

@property (nonatomic, assign) float y;

视频流对应区域左上角的纵坐标，该坐标是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。

width #

@property (nonatomic, assign) float width;

视频流对应区域宽度，该宽度是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。

height #

@property (nonatomic, assign) float height;

视频流对应区域高度，该高度是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。

alpha #

@property (nonatomic, assign) float alpha;

视频流在混流中的透明度，取值范围为 [0.0,1.0]，取值 0.0 表示全透明，取值 1.0 表示不透明。

zOrder #

@property (nonatomic, assign) int zOrder;

视频流在混流中的层级。取值范围为 [0,100]，取值 0 表示最底层，取值越大，层级越高。

renderMode #

@property (nonatomic, assign) VeLivePusherRenderMode renderMode;

视频流的渲染模式。详情请参见 VeLivePusherRenderMode。

enableAlpha #

@property (nonatomic, assign) BOOL enableAlpha;

是否保留视频流原 Alpha 通道值，默认为保留，当 alpha 取值在 [0.0, 1.0] 之间时，则忽略该配置。

• YES：保留；
• NO：不保留。
  

enablePreview #

@property (nonatomic, assign) BOOL enablePreview;

是否在本地预览画面中显示该视频流。默认值为 NO。

• YES：显示。
• NO：不显示。
  

enableStream #

@property (nonatomic, assign) BOOL enableStream;

是否将该视频流混入推向远端的视频流中。默认值为 YES。

• YES：混入。
• NO：不混入。远端用户将看不到该视频流。
  

@interface VeLiveMixAudioLayout : NSObject

音频混流设置。包含音频流 ID 属性。

成员变量 #

变量说明 #

streamId #

@property (nonatomic, assign) int streamId;

音频流 ID，唯一标识，用于区分不同的音频流。

volume #

@property (nonatomic, assign) float volume;

混流音频的音量，范围为 [0.0,4.0]。当你将 VeLiveAudioMixType 设置为 VeLiveAudioMixPlayAndPush 时，该属性同时控制混流音频在拉流端和本地的播放音量。

typedef NS_ENUM(
    NSInteger,
    VeLiveAudioProfile
)

AAC 音频编码档位。

枚举值 #

@interface VeLiveVideoFrame : NSObject <NSCopying>

视频帧的数据信息。

成员变量 #

成员函数 #

变量说明 #

bufferType #

@property (nonatomic, assign) VeLiveVideoBufferType bufferType;

视频数据包装格式。默认值为 VeLiveVideoBufferTypeUnknown，详情请参见 VeLiveVideoBufferType。

pixelFormat #

@property (nonatomic, assign) VeLivePixelFormat pixelFormat;

视频帧像素格式。bufferType 为 VeLiveVideoBufferTypeNSData 时，需要指定数据格式。详情请参见 VeLivePixelFormat。

rotation #

@property (nonatomic, assign) VeLiveVideoRotation rotation;

视频帧顺时针旋转角度。详情请参见 VeLiveVideoRotation。

width #

@property (nonatomic, assign) int width;

视频宽度，单位为 px。

height #

@property (nonatomic, assign) int height;

视频高度，单位为 px。

pts #

@property (nonatomic, assign) CMTime pts;

视频帧时间戳，单位为 μs。

textureId #

@property (nonatomic, assign) GLuint textureId;

bufferType 为 VeLiveVideoBufferTypeTexture 时的视频数据。

pixelBuffer #

@property (nonatomic, assign, nullable) CVPixelBufferRef pixelBuffer;

bufferType 为 VeLiveVideoBufferTypePixelBuffer 时的视频数据。

sampleBuffer #

@property (nonatomic, assign, nullable) CMSampleBufferRef sampleBuffer;

bufferType 为 VeLiveVideoBufferTypeSampleBuffer 时的视频数据。

data #

@property (nonatomic, strong, nullable) NSData *data;

bufferType 为 VeLiveVideoBufferTypeNSData 时的视频数据。

函数说明 #

releaseCallback #

@property (nonatomic, copy) void (^releaseCallback)(void);

释放回调函数，用于在 SDK 内部处理完 VideoFrame 后通知外部释放相关资源。此回调主要用于 SDK 外部为 VideoFrame 申请内存，以便 SDK 内部使用。但无法预知内部何时使用完毕。

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoFluencyLevel
)

视频流畅度等级，用于评估和描述视频播放的流畅程度。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoMirrorType
)

视频镜像类型。

枚举值 #

@interface VeLiveAudioCaptureConfiguration : NSObject

音频采集相关配置。

成员变量 #

变量说明 #

sampleRate #

@property (nonatomic, assign) VeLiveAudioSampleRate sampleRate;

音频采样率，默认值为 VeLiveAudioSampleRate44100，详情请参见 VeLiveAudioSampleRate。

channel #

@property (nonatomic, assign) VeLiveAudioChannel channel;

音频采集声道数，默认值为 VeLiveAudioChannelStereo，详情请参见 VeLiveAudioChannel。

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoResolution
)

推流视频分辨率档位枚举值。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoRotation
)

视频帧旋转角度。以 App 方向为旋转参考系。

枚举值 #

@interface VeLiveStreamMixDescription : NSObject

音视频混流布局。包含了视频混流布局、音频混流布局和画布背景色等属性。

成员变量 #

变量说明 #

mixVideoStreams #

@property (nonatomic, copy) NSArray<VeLiveMixVideoLayout*> *mixVideoStreams;

视频混流布局设置的数组，其中每个元素代表一路视频流的布局。详情请参见 VeLiveMixVideoLayout。

mixAudioStreams #

@property (nonatomic, copy) NSArray<VeLiveMixAudioLayout*> *mixAudioStreams;

音频混流设置的数组，其中每个元素代表一路音频流的。详情请参见 VeLiveMixAudioLayout。

backgroundColor #

@property (nonatomic, copy) NSString *backgroundColor;

视频混流画布的背景色设置，采用 #RRGGBB 格式。

typedef NS_ENUM(
    NSInteger,
    VeLiveAudioCaptureType
)

音频采集类型。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveVideoCodec
)

视频编码格式。

枚举值 #

@interface VeLiveVideoEncodeFrame : NSObject

视频编码帧，此类用于描述一个编码后的视频帧，包含时间戳、帧类型和编码数据。

成员变量 #

变量说明 #

pts #

@property (nonatomic, assign) CMTime pts;

编码帧展示时间戳，单位为 μs。

dts #

@property (nonatomic, assign) CMTime dts;

编码帧 dts 时间，即解码时间戳，单位为 μs。

videoEcodeFrameType #

@property (nonatomic, assign) VeLiveVideoEncodeFrameType videoEcodeFrameType;

编码帧的类型，详细请参见 VeLiveVideoEncodeFrameType:。

data #

@property (nonatomic, strong, nullable) NSData *data;

编码帧的数据，使用 NSData 表示。

@interface VeLiveAudioEncoderConfiguration : NSObject

推流音频编码参数。

成员变量 #

变量说明 #

bitrate #

@property (nonatomic, assign) int bitrate;

音频编码码率，单位为 kbps，默认值为 64。

sampleRate #

@property (nonatomic, assign) VeLiveAudioSampleRate sampleRate;

音频编码采样率，默认值为 VeLiveAudioSampleRate44100，详情请参见 VeLiveAudioSampleRate。

channel #

@property (nonatomic, assign) VeLiveAudioChannel channel;

音频声道数，默认值为 VeLiveAudioChannelStereo，详情请参见 VeLiveAudioChannel。

profile #

@property (nonatomic, assign) VeLiveAudioProfile profile;

AAC 编码类型，默认值为 VeLiveAudioAACProfileLC。详情请参见 VeLiveAudioProfile。

typedef NS_ENUM(
    NSInteger,
    VeLivePusherLogLevel
)

输出的日志级别。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLiveAudioMixType
)

音频混流类型。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    VeLivePusherRenderMode
)

推流渲染模式。

枚举值 #

@interface VeLiveVideoEffectLicenseConfiguration : NSObject

视频特效许可证配置。

成员变量 #

成员函数 #

变量说明 #

type #

@property (nonatomic, assign, readonly) VeLiveVideoEffectLicenseType type;

获取视频特效许可证类型。许可证类型请参见 VeLiveVideoEffectLicenseType。

path #

@property (nonatomic, copy, readonly, nullable) NSString *path;

获取视频特效许可证的本地路径。当 VeLiveVideoEffectLicenseType 为 VeLiveVideoEffectLicenseTypeOffLine 时，该属性返回许可证文件的本地路径。

key #

@property (nonatomic, copy, readonly, nullable) NSString *key;

获取视频特效许可证的在线认证 key。当 VeLiveVideoEffectLicenseType 为 VeLiveVideoEffectLicenseTypeOnLine 时，该属性返回在线认证的 key。

secret #

@property (nonatomic, copy, readonly, nullable) NSString *secret;

获取视频特效许可证的在线认证 secret。当 VeLiveVideoEffectLicenseType 为 VeLiveVideoEffectLicenseTypeOnLine 时，该属性返回在线认证的 secret。

url #

@property (nonatomic, copy, readonly, nullable) NSString *url;

获取视频特效许可证的在线认证地址。当 VeLiveVideoEffectLicenseType 为 VeLiveVideoEffectLicenseTypeOnLine 时，该属性返回在线认证地址。

函数说明 #

initWithPath: #

- (instancetype)initWithPath:(NSString *)path NS_DESIGNATED_INITIALIZER;

初始化配置为本地验证模式。

传入参数

返回值

返回 VeLiveVideoEffectLicenseConfiguration 类的实例，该实例使用指定的本地路径进行许可证验证。

initWithKey:secret:url: #

- (instancetype)initWithKey:(NSString *)key secret:(NSString *)secret url:(nullable NSString *)url NS_DESIGNATED_INITIALIZER;

初始化配置为在线验证模式。

传入参数