其他类函数待分类
MediaCreateAudioCapturer
CAPL 函数 >> 媒体 API >> MediaCreateAudioCapturer
函数
语法
dword MediaCreateAudioCapturer();
功能
创建流式音频捕获器,作为从输入设备(如麦克风)捕获音频的媒体源。音频捕获器提供未压缩的音频数据,格式可为 PCM 或 IEEE 浮点格式。
参数
无
返回值
- 0:函数执行失败。调用
MediaGetLastError获取具体错误代码。 - ≠0:音频捕获器句柄
可用性
- 起始版本:8.5
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaCreateAudioRenderer
CAPL 函数 >> 媒体 API >> MediaCreateAudioRenderer
函数
语法
dword MediaCreateAudioRenderer();
功能
创建流式音频渲染器(SAR),作为在输出设备(如耳机或扬声器)中播放音频的媒体接收器。每个 SAR 实例仅渲染单个音频流;若需渲染多个流,需使用多个 SAR 实例。SAR 可接收未压缩的音频数据,格式可为 PCM 或 IEEE 浮点格式。
参数
无
返回值
- 0:函数执行失败。调用
MediaGetLastError获取具体错误代码。 - ≠0:音频渲染器句柄
可用性
- 起始版本:8.5
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
版本 14 SP2
© Vector Informatik GmbH
MediaCreateMediaType
CAPL 函数 >> 媒体 API >> MediaCreateMediaType
函数
语法
dword MediaCreateMediaType();
功能
创建空媒体类型。使用后需调用 MediaReleaseMediaType 释放该媒体类型。
参数
无
返回值
- 0:函数执行失败。调用
MediaGetLastError获取具体错误代码。 - ≠0:媒体类型句柄
可用性
- 起始版本:10.0
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaEnumAudioCapturers
CAPL 函数 >> 媒体 API >> MediaEnumAudioCapturers
函数
语法
dword MediaEnumAudioCapturers(dword& count, dword audioCapturerHandles[]);
功能
枚举音频捕获设备列表。
参数
count:audioCapturerHandles数组中的元素数量。调用者需设为elCount(audioCapturerHandles)。函数成功返回后,此参数包含数组中有效句柄的数量。audioCapturerHandles:存储所有可用音频捕获设备句柄的数组。使用后,调用者需通过MediaReleaseAudioCapturer释放数组中的每个句柄。
返回值
- 0:函数执行成功。
- ≠0:错误代码
可用性
- 起始版本:10.0
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaEnumVideoCapturers
CAPL 函数 >> 媒体 API >> MediaEnumVideoCapturers
函数
语法
dword MediaEnumVideoCapturers(dword[] retVideoCapturerHandles, dword &retCount);
功能
枚举视频捕获设备列表。
参数
retCount:videoCapturerHandles数组中的元素数量。调用者需设为elCount(videoCapturerHandles)。函数成功返回后,此参数包含数组中有效句柄的数量。retVideoCapturerHandles:存储所有可用视频捕获设备句柄的数组。使用后,调用者需通过MediaReleaseVideoCapturer释放数组中的每个句柄。
返回值
- 0:函数执行成功。
- ≠0:错误代码
可用性
- 起始版本:10.0
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaReleaseAudioCapturer
CAPL 函数 >> 媒体 API >> MediaReleaseAudioCapturer
函数
语法
dword MediaReleaseAudioCapturer(dword audioCapturerHandle);
功能
释放音频捕获器。
参数
audioCapturerHandle:音频捕获器句柄
返回值
- 0:函数执行成功。
- ≠0:错误代码
可用性
- 起始版本:8.5
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaReleaseAudioRenderer
CAPL 函数 >> 媒体 API >> MediaReleaseAudioRenderer
函数
语法
long MediaReleaseAudioRenderer(dword audioRendererHandle);
功能
释放音频渲染器。
参数
audioRendererHandle:音频渲染器句柄
返回值
- 0:函数执行成功。
- ≠0:错误代码
可用性
- 起始版本:8.5
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaReleaseMediaType
CAPL 函数 >> 媒体 API >> MediaReleaseMediaType
函数
语法
long MediaReleaseMediaType(dword mediaTypeHandle);
功能
释放通过 MediaGetMediaType 获取的媒体类型。
参数
mediaTypeHandle:媒体类型句柄
返回值
- 0:函数执行成功。
- ≠0:错误代码
可用性
- 起始版本:8.5
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaReleaseVideoCapturer
CAPL 函数 >> 媒体 API >> MediaReleaseVideoCapturer
函数
语法
dword MediaReleaseVideoCapturer(dword videoCapturerHandle);
功能
释放视频捕获器。
参数
videoCapturerHandle:视频捕获器句柄
返回值
- 0:函数执行成功。
- ≠0:错误代码
可用性
- 起始版本:10.0
- 限制范围:
- 测量设置:---
- 仿真/测试设置:•
示例
另请参见
MediaWrite
CAPL 函数 >> 媒体 API >> MediaWrite
函数
向接收器写入器传递样本数据。函数返回后,缓冲区可立即重用。
语法
capl
long MediaWrite(dword sinkWriterHandle, dword streamIndex, int64 timestamp, byte buffer[], dword length);
long MediaWrite(dword sinkWriterHandle, dword streamIndex, int64 timestamp, int buffer[], dword length);
long MediaWrite(dword sinkWriterHandle, dword streamIndex, int64 timestamp, long buffer[], dword length);
参数
- sinkWriterHandle:接收器写入器句柄。
- streamIndex:流的从零开始的索引。
- buffer:用于存储样本数据的缓冲区。
- length:数据缓冲区的长度。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaReleaseSinkWriter
CAPL 函数 >> 媒体 API >> MediaReleaseSinkWriter
函数
释放接收器写入器。
语法
capl
long MediaReleaseSinkWriter(dword sinkWriterHandle);
参数
- sinkWriterHandle:接收器写入器句柄。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaCreateSinkWriterFromURL
CAPL 函数 >> 媒体 API >> MediaCreateSinkWriterFromURL
函数
从 URL 创建接收器写入器。有关接收器写入器的更多信息,请参见接收器写入器。
语法
capl
dword MediaCreateSinkWriterFromURL(char mediaFileUrl[]);
参数
- mediaFileUrl:以 null 结尾的字符串,包含输出文件的 URL。有关文件中支持的媒体格式列表,请参见支持的媒体格式。
返回值
- 0:函数执行失败。调用 MediaGetLastError 获取具体错误代码。
- ≠0:接收器写入器句柄。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaCreateSinkWriterFromMediaSink
CAPL 函数 >> 媒体 API >> MediaCreateSinkWriterFromMediaSink
函数
从媒体源创建源读取器。有关源读取器的更多信息,请参见源读取器。
语法
capl
dword MediaCreateSinkWriterFromMediaSink(dword mediaSinkHandle);
参数
- mediaFileHandle:用于创建接收器写入器的媒体接收器。此句柄由 MediaCreateAudioRenderer 函数返回。
返回值
- 0:函数执行失败。调用 MediaGetLastError 获取具体错误代码。
- ≠0:接收器写入器句柄。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaSetInputType
CAPL 函数 >> 媒体 API >> MediaSetInputType
函数
为多路复用器的指定索引设置输入媒体类型。
语法
capl
long MediaSetInputType(dword multiplexerHandle, dword inputStreamIndex, dword mediaTypeHandle);
参数
- multiplexerHandle:由 MediaCreateMultiplexer 函数返回的多路复用器句柄。
- inputStreamIndex:要设置媒体类型的输入流索引。当前每个多路复用流仅支持 1 个输入流,因此请将此参数设为 0。
- mediaTypeHandle:描述输入流格式的媒体类型句柄。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:13.0
- 适用场景:仅适用于仿真/测试设置
MediaReleaseMultiplexer
CAPL 函数 >> 媒体 API >> MediaReleaseMultiplexer
函数
释放多路复用器。
语法
capl
long MediaReleaseMultiplexer(dword multiplexerHandle);
参数
- multiplexerHandle:由 MediaCreateMultiplexer 函数返回的多路复用器句柄。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:13.0
- 适用场景:仅适用于仿真/测试设置
MediaProcessOutput
CAPL 函数 >> 媒体 API >> MediaProcessOutput
函数
从当前输入数据生成输出。
语法
capl
long MediaProcessOutput(dword multiplexerHandle, dword outputStreamIndex, int64& retTimestamp, byte buffer[], dword& length, dword& retStatus);
参数
- multiplexerHandle:由 MediaCreateMultiplexer 函数返回的多路复用器句柄。
- outputStreamIndex:要检索媒体类型的输出流索引。对于多路复用器,设为 0。
- retTimestamp:函数返回的(呈现)时间戳(以纳秒为单位)。此时间相对于流的开始(非绝对 gPTP 时间)。
- buffer:要处理的输入流样本数据。
- length:输入/输出参数。调用函数前设为 elCount(buffer)。函数返回后,包含缓冲区数组中样本数据的字节长度。
- retStatus:调用 MediaProcessOutput 前,将此成员设为 0。方法返回时,多路复用器可能设置额外的状态标志;否则,此成员保持为 0。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:13.0
- 适用场景:仅适用于仿真/测试设置
MediaProcessInput
CAPL 函数 >> 媒体 API >> MediaProcessInput
函数
向多路复用器的输入流传递数据。
语法
capl
long MediaProcessInput(dword multiplexerHandle, dword inputStreamIndex, int64 timestamp, byte buffer[], dword length);
参数
- multiplexerHandle:由 MediaCreateMultiplexer 函数返回的多路复用器句柄。
- inputStreamIndex:要设置媒体类型的输入流索引。当前每个多路复用流仅支持 1 个输入流,因此请将此参数设为 0。
- timestamp:(呈现)时间戳(以纳秒为单位)。此时间相对于流的开始(非绝对 gPTP 时间)。
- buffer:要处理的输入流样本数据。
- length:缓冲区数组中样本数据的字节长度。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:13.0
- 适用场景:仅适用于仿真/测试设置
MediaGetOutputType
CAPL 函数 >> 媒体 API >> MediaGetOutputType
函数
检索多路复用器在指定索引处生成的输出流的媒体类型。
语法
capl
dword MediaGetOutputType(dword multiplexerHandle, dword outputStreamIndex);
参数
- multiplexerHandle:由 MediaCreateMultiplexer 函数返回的多路复用器句柄。
- onputStreamIndex:要检索媒体类型的输出流索引。对于多路复用器,设为 0。
返回值
- 0:函数执行失败。调用 MediaGetLastError 获取具体错误代码。
- ≠0:媒体类型句柄。
可用性
- 起始版本:13.0
- 适用场景:仅适用于仿真/测试设置
MediaCreateMultiplexer
CAPL 函数 >> 媒体 API >> MediaCreateMultiplexer
函数
为提供的输出媒体子类型创建多路复用器。有关子类型列表,请参见主要媒体类型/子类型。
语法
capl
dword MediaCreateMultiplexer(char outputSubtype[]);
参数
- outputSubtype:描述输出(多路复用)流格式的媒体子类型。当前支持的子类型:StreamFormat_MPEG2Transport。多路复用流的主要类型始终为 MajorType_Stream。
返回值
- 0:函数执行失败。调用 MediaGetLastError 获取具体错误代码。
- ≠0:多路复用器句柄。
可用性
- 起始版本:13.0
- 适用场景:仅适用于仿真/测试设置
MediaCreateSourceReaderFromMediaSource
CAPL 函数 >> 媒体 API >> MediaCreateSourceReaderFromMediaSource
函数
从媒体源创建源读取器。
有关源读取器的更多信息,请参见源读取器。
语法
capl
dword MediaCreateSourceReaderFromMediaSource(dword mediaSourceHandle);
参数
- mediaSourceHandle :用于创建源读取器的媒体源。
该句柄由MediaCreateAudioCapturer函数返回。
返回值
- 0 :函数执行失败。调用
MediaGetLastError获取具体错误代码。 - ≠0:源读取器句柄。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaCreateSourceReaderFromURL
CAPL 函数 >> 媒体 API >> MediaCreateSourceReaderFromURL
函数
从 URL 创建源读取器。
有关源读取器的更多信息,请参见源读取器。
语法
capl
dword MediaCreateSourceReaderFromURL(char mediaFileUrl[]);
参数
- mediaFileUrl :要打开的媒体文件的 URL。
支持的媒体文件格式列表,请参见支持的媒体格式。
返回值
- 0 :函数执行失败。调用
MediaGetLastError获取具体错误代码。 - ≠0:源读取器句柄。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaGetMediaType
CAPL 函数 >> 媒体 API >> MediaGetMediaType
函数
获取源读取器的媒体类型。
语法
capl
long MediaGetMediaType(dword sourceReaderHandle, dword streamIndex);
参数
- sourceReaderHandle:源读取器句柄。
- streamIndex:要查询的流。取值范围如下:
| 值 | 描述 |
|---|---|
| 0--0xFFFFFFFB | 流的从零开始的索引 |
| SOURCE_READER_FIRST_VIDEO_STREAM (0xFFFFFFFC) | 第一个视频流 |
| SOURCE_READER_FIRST_AUDIO_STREAM (0xFFFFFFFD) | 第一个音频流 |
返回值
- 0 :函数执行失败。调用
MediaGetLastError获取具体错误代码。 - ≠0:媒体类型句柄。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaRead
CAPL 函数 >> 媒体 API >> MediaRead
函数
从媒体源读取样本数据。
语法
capl
long MediaRead(dword sourceReaderHandle, dword streamIndex, byte buffer[], dword length, char onReadCallback[]);
long MediaRead(dword sourceReaderHandle, dword streamIndex, int buffer[], dword length, char onReadCallback[]);
long MediaRead(dword sourceReaderHandle, dword streamIndex, long buffer[], dword length, char onReadCallback[]);
参数
- sourceReaderHandle:源读取器句柄。
- streamIndex:要拉取数据的流。取值范围如下:
| 名称 | 描述 |
|---|---|
| 0--0xFFFFFFFB | 流的从零开始的索引 |
| SOURCE_READER_FIRST_VIDEO_STREAM (0xFFFFFFFC) | 第一个视频流 |
| SOURCE_READER_FIRST_AUDIO_STREAM (0xFFFFFFFD) | 第一个音频流 |
| SOURCE_READER_ANY_STREAM (0xFFFFFFFE) | 获取下一个可用样本(不限流) |
- buffer:用于存储输入数据的缓冲区。
- length:数据缓冲区的长度。
- onReadCallback :CAPL 回调函数名称(参见
OnMediaRead)。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaReleaseSourceReader
CAPL 函数 >> 媒体 API >> MediaReleaseSourceReader
函数
释放源读取器。
语法
capl
long MediaReleaseSourceReader(dword sourceReaderHandle);
参数
- sourceReaderHandle:源读取器句柄。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置
MediaSetMediaType
CAPL 函数 >> 媒体 API >> MediaSetMediaType
函数
为源读取器或接收器写入器设置媒体类型。
-
源读取器 :该媒体类型定义源读取器通过
MediaRead输出的数据格式,可与媒体源提供的原生格式不同。源读取器首先尝试将媒体类型设置为媒体源的原生类型;若失败,则尝试加载支持格式转换的解码器(若可用)。
-
接收器写入器 :该媒体类型定义接收器写入器通过
MediaWrite接收的输入格式,可与媒体接收器的原生格式不同。接收器写入器首先尝试将媒体类型设置为媒体接收器的原生类型;若失败,则尝试加载支持格式转换的编码器(若可用)。
语法
capl
long MediaSetMediaType(dword sourceReaderOrSinkWriterHandle, dword streamIndex, dword mediaTypeHandle);
参数
- mediaTypeHandle:媒体类型句柄。
返回值
- 0:函数执行成功。
- ≠0:错误代码。
可用性
- 起始版本:8.5
- 适用场景:仅适用于仿真/测试设置