avmedia_source.h

概述

定义AVMediaSource的结构体和枚举类型。

引用文件： <multimedia/player_framework/avmedia_source.h>

库： libavmedia_source.so

系统能力： SystemCapability.Multimedia.Media.Core

起始版本： 23

相关模块： avmedia_source

汇总

结构体

名称	typedef关键字	描述
OH_AVHttpHeader	OH_AVHttpHeader	声明HTTP头部类型。
OH_AVMediaSource	OH_AVMediaSource	声明媒体源类型。
OH_AVMediaSourceLoadingRequest	OH_AVMediaSourceLoadingRequest	加载请求对象。应用通过该对象获取所请求资源的位置。
OH_AVMediaSourceLoader	OH_AVMediaSourceLoader	声明媒体数据加载器类型，由应用实现。

枚举

名称	typedef关键字	描述
AVLoadingRequestError	AVLoadingRequestError	网络加载请求的错误码枚举。

函数

名称	typedef关键字	描述
OH_AVHttpHeader *OH_AVHttpHeader_Create(void)	-	创建一个HTTP头部实例。
OH_AVErrCode OH_AVHttpHeader_Destroy(OH_AVHttpHeader *header)	-	释放一个HTTP头部实例。
OH_AVErrCode OH_AVHttpHeader_GetCount(OH_AVHttpHeader header, uint32_t count)	-	获取HTTP头部实例中的记录项数量。
OH_AVErrCode OH_AVHttpHeader_AddRecord(OH_AVHttpHeader header, const char key, const char *value)	-	向HTTP头部实例中添加一个键值对记录。
OH_AVErrCode OH_AVHttpHeader_GetRecord(OH_AVHttpHeader header, uint32_t index, const char key, const char *value)	-	通过索引获取HTTP头部实例中的键值对记录。
OH_AVMediaSource OH_AVMediaSource_CreateWithUrl(const char url, OH_AVHttpHeader *header)	-	通过URL创建媒体源。
OH_AVMediaSource OH_AVMediaSource_CreateWithDataSource(OH_AVDataSource dataSource)	-	通过OH_AVDataSource创建媒体源。
OH_AVMediaSource *OH_AVMediaSource_CreateWithFd(int32_t fd, int64_t offset, int64_t size)	-	通过文件描述符（FileDescriptor）创建媒体源。
OH_AVErrCode OH_AVMediaSource_Destroy(OH_AVMediaSource *source)	-	释放media source实例。
OH_AVErrCode OH_AVMediaSource_SetMimeType(OH_AVMediaSource source, const char mimetype)	-	设置媒体MIME类型以处理扩展媒体源。
OH_AVErrCode OH_AVMediaSourceLoadingRequest_GetUrl(OH_AVMediaSourceLoadingRequest request, const char *url)	-	获取请求的URL。
OH_AVErrCode OH_AVMediaSourceLoadingRequest_GetHttpHeader(OH_AVMediaSourceLoadingRequest request, OH_AVHttpHeader *header)	-	获取请求的HTTP头部。
int32_t OH_AVMediaSourceLoadingRequest_RespondData(OH_AVMediaSourceLoadingRequest request, int64_t uuid, int64_t offset, const uint8_t data, uint64_t dataSize)	-	用于向AVPlayer发送请求数据的接口。
void OH_AVMediaSourceLoadingRequest_RespondHeader(OH_AVMediaSourceLoadingRequest request, int64_t uuid, OH_AVHttpHeader header, const char *redirectUrl)	-	应用用于向AVPlayer发送响应头部的接口，必须在首次调用OH_AVMediaSourceLoadingRequest_RespondData之前调用。
void OH_AVMediaSourceLoadingRequest_FinishLoading(OH_AVMediaSourceLoadingRequest *request, int64_t uuid, AVLoadingRequestError error)	-	通知播放器当前请求的状态。在推送完单个资源的所有数据后，应用应发送LOADING_ERROR_SUCCESS状态，以通知播放器资源推送已完成。
OH_AVMediaSourceLoader *OH_AVMediaSourceLoader_Create(void)	-	创建一个OH_AVMediaSourceLoader实例。成功时返回OH_AVMediaSourceLoader指针，失败时返回空指针。
OH_AVErrCode OH_AVMediaSourceLoader_Destroy(OH_AVMediaSourceLoader *loader)	-	释放OH_AVMediaSourceLoader实例。
OH_AVErrCode OH_AVMediaSource_SetMediaSourceLoader(OH_AVMediaSource source, OH_AVMediaSourceLoader loader)	-	为媒体源实例设置一个源加载器。
typedef int64_t (OH_AVMediaSourceLoaderOnSourceOpenedCallback)(OH_AVMediaSourceLoadingRequest request, void *userData)	OH_AVMediaSourceLoaderOnSourceOpenedCallback	定义由服务端调用的SourceOpenCallback函数。客户端应处理传入的请求，并返回所打开资源的唯一句柄。客户端必须在处理完请求后立即返回该句柄。
typedef void (OH_AVMediaSourceLoaderOnSourceReadCallback)(int64_t uuid, int64_t requestedOffset, int64_t requestedLength, void userData)	OH_AVMediaSourceLoaderOnSourceReadCallback	定义由服务端调用的SourceReadCallback函数。客户端应记录读取请求，并在有足够数据时通过请求对象的OH_AVMediaSourceLoadingRequest_RespondData和OH_AVMediaSourceLoadingRequest_RespondHeader方法推送数据。客户端必须在处理完请求后立即返回。
typedef void (OH_AVMediaSourceLoaderOnSourceClosedCallback)(int64_t uuid, void userData)	OH_AVMediaSourceLoaderOnSourceClosedCallback	定义由服务端调用的SourceCloseCallback函数。客户端应释放相关资源，并在处理完请求后立即返回。
OH_AVErrCode OH_AVMediaSourceLoader_SetSourceOpenCallback(OH_AVMediaSourceLoader loader, OH_AVMediaSourceLoaderOnSourceOpenedCallback callback, void userData)	-	为OH_AVMediaSourceLoader设置打开回调函数。
OH_AVErrCode OH_AVMediaSourceLoader_SetSourceReadCallback(OH_AVMediaSourceLoader loader, OH_AVMediaSourceLoaderOnSourceReadCallback callback, void userData)	-	为OH_AVMediaSourceLoader设置读取回调函数。
OH_AVErrCode OH_AVMediaSourceLoader_SetSourceCloseCallback(OH_AVMediaSourceLoader loader, OH_AVMediaSourceLoaderOnSourceClosedCallback callback, void userData)	-	为OH_AVMediaSourceLoader设置关闭回调函数。

枚举类型说明

AVLoadingRequestError

enum AVLoadingRequestError

描述

网络加载请求的错误码枚举。

起始版本： 23

枚举项	描述
AV_LOADING_ERROR_SUCCESS = 0	资源成功下载。
AV_LOADING_ERROR_NOT_READY = 1	资源未准备好，无法访问。
AV_LOADING_ERROR_NO_RESOURCE = 2	资源URL不存在。
AV_LOADING_ERROR_INVALID_HANDLE = 3	资源句柄的UUID无效。
AV_LOADING_ERROR_ACCESS_DENIED = 4	客户端无权请求该资源。
AV_LOADING_ERROR_ACCESS_TIMEOUT = 5	访问超时。
AV_LOADING_ERROR_AUTHORIZE_FAILED = 6	授权失败。

函数说明

OH_AVHttpHeader_Create()

OH_AVHttpHeader *OH_AVHttpHeader_Create(void)

描述

创建一个HTTP头部实例。

起始版本： 23

返回：

类型	说明
OH_AVHttpHeader *	成功时返回指向OH_AVHttpHeader实例的指针，失败时返回空指针。

OH_AVHttpHeader_Destroy()

OH_AVErrCode OH_AVHttpHeader_Destroy(OH_AVHttpHeader *header)

描述

释放一个HTTP头部实例。

起始版本： 23

参数：

参数项	描述
OH_AVHttpHeader *header	指向OH_AVHttpHeader实例的指针。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示header为空指针或实例销毁失败。

OH_AVHttpHeader_GetCount()

OH_AVErrCode OH_AVHttpHeader_GetCount(OH_AVHttpHeader *header, uint32_t *count)

描述

获取HTTP头部实例中的记录项数量。

起始版本： 23

参数：

参数项	描述
OH_AVHttpHeader *header	指向OH_AVHttpHeader实例的指针。
uint32_t *count	用于输出头部实例中记录项的数量。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示header为空指针。

OH_AVHttpHeader_AddRecord()

OH_AVErrCode OH_AVHttpHeader_AddRecord(OH_AVHttpHeader *header, const char *key, const char *value)

描述

向HTTP头部实例中添加一个键值对记录。

起始版本： 23

参数：

参数项	描述
OH_AVHttpHeader *header	指向OH_AVHttpHeader实例的指针。
const char *key	记录的键名。
const char *value	记录的值。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示任一参数为空指针。

OH_AVHttpHeader_GetRecord()

OH_AVErrCode OH_AVHttpHeader_GetRecord(OH_AVHttpHeader *header, uint32_t index, const char **key, const char **value)

描述

通过索引获取HTTP头部实例中的键值对记录。

起始版本： 23

参数：

参数项	描述
OH_AVHttpHeader *header	指向OH_AVHttpHeader实例的指针。
uint32_t index	记录在头部中的位置。
const char **key	用于输出记录的键名。
const char **value	用于输出记录的值。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示header为空指针或索引越界。

OH_AVMediaSource_CreateWithUrl()

OH_AVMediaSource *OH_AVMediaSource_CreateWithUrl(const char *url, OH_AVHttpHeader *header)

描述

通过URL创建媒体源。

起始版本： 23

参数：

参数项	描述
const char *url	媒体源的URL。支持以下流媒体格式：HLS、HTTP-FLV、DASH和HTTPS。
OH_AVHttpHeader *header	附加到网络请求的HTTP头部。

返回：

类型	说明
OH_AVMediaSource *	成功时返回指向OH_AVMediaSource实例的指针，失败时返回空指针。

OH_AVMediaSource_CreateWithDataSource()

OH_AVMediaSource *OH_AVMediaSource_CreateWithDataSource(OH_AVDataSource *dataSource)

描述

通过OH_AVDataSource创建媒体源。

起始版本： 23

参数：

参数项	描述
OH_AVDataSource *dataSource	指向OH_AVDataSource的指针。

返回：

类型	说明
OH_AVMediaSource *	成功时返回指向OH_AVMediaSource实例的指针，失败时返回空指针。

OH_AVMediaSource_CreateWithFd()

OH_AVMediaSource *OH_AVMediaSource_CreateWithFd(int32_t fd, int64_t offset, int64_t size)

描述

通过文件描述符（FileDescriptor）创建媒体源。

起始版本： 23

参数：

参数项	描述
int32_t fd	数据源的文件描述符。
int64_t offset	开始读取的文件偏移量。
int64_t size	文件大小（以字节为单位）。

返回：

类型	说明
OH_AVMediaSource *	成功时返回指向OH_AVMediaSource实例的指针，失败时返回空指针。

OH_AVMediaSource_Destroy()

OH_AVErrCode OH_AVMediaSource_Destroy(OH_AVMediaSource *source)

描述

释放media source实例。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSource *source	指向OH_AVMediaSource实例的指针。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示source为空指针或释放失败。

OH_AVMediaSource_SetMimeType()

OH_AVErrCode OH_AVMediaSource_SetMimeType(OH_AVMediaSource *source, const char *mimetype)

描述

设置媒体MIME类型以处理扩展媒体源。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSource *source	指向OH_AVMediaSource的指针。
const char *mimetype	媒体源的MIME类型AV_MimeTypes。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示source或mimetype为空指针。 AV_ERR_UNSUPPORTED_FORMAT：表示不支持该mimetype。

OH_AVMediaSourceLoadingRequest_GetUrl()

OH_AVErrCode OH_AVMediaSourceLoadingRequest_GetUrl(OH_AVMediaSourceLoadingRequest *request, const char **url)

描述

获取请求的URL。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoadingRequest *request	OH_AVMediaSourceLoadingRequest实例。
const char **url	用于输出的URL字符串。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示request为空指针或不存在URL。

OH_AVMediaSourceLoadingRequest_GetHttpHeader()

OH_AVErrCode OH_AVMediaSourceLoadingRequest_GetHttpHeader(OH_AVMediaSourceLoadingRequest *request, OH_AVHttpHeader **header)

描述

获取请求的HTTP头部。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoadingRequest *request	OH_AVMediaSourceLoadingRequest实例。
OH_AVHttpHeader **header	用于HTTP请求的HTTP头部。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示request为空指针。

OH_AVMediaSourceLoadingRequest_RespondData()

int32_t OH_AVMediaSourceLoadingRequest_RespondData(OH_AVMediaSourceLoadingRequest *request, int64_t uuid, int64_t offset, const uint8_t *data, uint64_t dataSize)

描述

用于向AVPlayer发送请求数据的接口。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoadingRequest *request	资源打开请求的参数。
int64_t uuid	资源句柄的ID。
int64_t offset	当前媒体数据相对于资源起始位置的偏移量。
const uint8_t *data	发送给播放器的媒体数据。
uint64_t dataSize	发送给播放器的数据长度。

返回：

类型	说明
int32_t	当前读取操作接受的字节数。返回值小于零表示失败； -2 表示播放器不再需要当前数据，客户端应停止当前读取过程； -3 表示播放器缓冲区已满，客户端应等待下一次读取。

OH_AVMediaSourceLoadingRequest_RespondHeader()

void OH_AVMediaSourceLoadingRequest_RespondHeader(OH_AVMediaSourceLoadingRequest *request, int64_t uuid, OH_AVHttpHeader *header, const char *redirectUrl)

描述

应用用于向AVPlayer发送响应头部的接口，必须在首次调用OH_AVMediaSourceLoadingRequest_RespondData之前调用。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoadingRequest *request	资源打开请求的参数。
int64_t uuid	资源句柄的ID。
OH_AVHttpHeader *header	HTTP响应中的头部信息。应用可将该头部字段与底层支持的字段进行交集处理后再传入，也可直接传入所有对应的头部信息。
const char *redirectUrl	HTTP响应中包含的重定向URL（如果存在）。

OH_AVMediaSourceLoadingRequest_FinishLoading()

void OH_AVMediaSourceLoadingRequest_FinishLoading(OH_AVMediaSourceLoadingRequest *request, int64_t uuid, AVLoadingRequestError error)

描述

通知播放器当前请求的状态。在推送完单个资源的所有数据后，应用应发送LOADING_ERROR_SUCCESS状态，以通知播放器资源推送已完成。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoadingRequest *request	资源打开请求的参数。
int64_t uuid	资源句柄的ID。
AVLoadingRequestError error	错误状态。

OH_AVMediaSourceLoader_Create()

OH_AVMediaSourceLoader *OH_AVMediaSourceLoader_Create(void)

描述

创建一个OH_AVMediaSourceLoader实例。成功时返回OH_AVMediaSourceLoader指针，失败时返回空指针。

起始版本： 23

OH_AVMediaSourceLoader_Destroy()

OH_AVErrCode OH_AVMediaSourceLoader_Destroy(OH_AVMediaSourceLoader *loader)

描述

释放OH_AVMediaSourceLoader实例。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoader *loader	待释放的OH_AVMediaSourceLoader实例。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示loader为空指针或释放失败。

OH_AVMediaSource_SetMediaSourceLoader()

OH_AVErrCode OH_AVMediaSource_SetMediaSourceLoader(OH_AVMediaSource *source, OH_AVMediaSourceLoader *loader)

描述

为媒体源实例设置一个源加载器。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSource *source	需要网络代理的OH_AVMediaSource。
OH_AVMediaSourceLoader *loader	OH_AVMediaSourceLoader实例。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示source或loader为空指针，或操作失败。

OH_AVMediaSourceLoaderOnSourceOpenedCallback()

typedef int64_t (*OH_AVMediaSourceLoaderOnSourceOpenedCallback)(OH_AVMediaSourceLoadingRequest *request, void *userData)

描述

定义由服务端调用的SourceOpenCallback函数。客户端应处理传入的请求，并返回所打开资源的唯一句柄。客户端必须在处理完请求后立即返回该句柄。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoadingRequest *request	资源打开请求的参数，包含所请求资源的详细信息及数据推送方式。
void *userData	用户在OH_AVMediaSourceLoader_SetSourceOpenCallback中设置的数据。

返回：

类型	说明
int64_t	当前资源打开请求的句柄，该句柄对请求对象是唯一的。大于0的值表示请求成功；小于或等于0的值表示失败。

OH_AVMediaSourceLoaderOnSourceReadCallback()

typedef void (*OH_AVMediaSourceLoaderOnSourceReadCallback)(int64_t uuid, int64_t requestedOffset, int64_t requestedLength, void *userData)

描述

定义由服务端调用的SourceReadCallback函数。客户端应记录读取请求，并在有足够数据时通过请求对象的OH_AVMediaSourceLoadingRequest_RespondData和OH_AVMediaSourceLoadingRequest_RespondHeader方法推送数据。客户端必须在处理完请求后立即返回。

起始版本： 23

参数：

参数项	描述
int64_t uuid	资源句柄的ID。
int64_t requestedOffset	当前媒体数据相对于资源起始位置的偏移量。
int64_t requestedLength	当前请求的数据长度。-1 表示已到达资源末尾，需通过OH_AVMediaSourceLoadingRequest_FinishLoading方法通知播放器推送结束。
void *userData	用户在OH_AVMediaSourceLoader_SetSourceReadCallback中设置的数据。

OH_AVMediaSourceLoaderOnSourceClosedCallback()

typedef void (*OH_AVMediaSourceLoaderOnSourceClosedCallback)(int64_t uuid, void *userData)

描述

定义由服务端调用的SourceCloseCallback函数。客户端应释放相关资源，并在处理完请求后立即返回。

起始版本： 23

参数：

参数项	描述
int64_t uuid	资源句柄的ID。
void *userData	用户在OH_AVMediaSourceLoader_SetSourceCloseCallback中设置的数据。

OH_AVMediaSourceLoader_SetSourceOpenCallback()

OH_AVErrCode OH_AVMediaSourceLoader_SetSourceOpenCallback(OH_AVMediaSourceLoader *loader, OH_AVMediaSourceLoaderOnSourceOpenedCallback callback, void *userData)

描述

为OH_AVMediaSourceLoader设置打开回调函数。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoader *loader	要设置回调函数的OH_AVMediaSourceLoader实例。
OH_AVMediaSourceLoaderOnSourceOpenedCallback callback	要设置的打开回调函数。
void *userData	回调函数中使用的用户自定义数据。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示loader为空指针或操作失败。

OH_AVMediaSourceLoader_SetSourceReadCallback()

OH_AVErrCode OH_AVMediaSourceLoader_SetSourceReadCallback(OH_AVMediaSourceLoader *loader, OH_AVMediaSourceLoaderOnSourceReadCallback callback, void *userData)

描述

为OH_AVMediaSourceLoader设置读取回调函数。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoader *loader	要设置回调函数的OH_AVMediaSourceLoader实例。
OH_AVMediaSourceLoaderOnSourceReadCallback callback	要设置的读取回调函数。
void *userData	回调函数中使用的用户自定义数据。

返回：

类型	说明
OH_AVErrCode	函数执行结果。 AV_ERR_OK：表示执行成功。 AV_ERR_INVALID_VAL：表示loader为空指针或操作失败。

OH_AVMediaSourceLoader_SetSourceCloseCallback()

OH_AVErrCode OH_AVMediaSourceLoader_SetSourceCloseCallback(OH_AVMediaSourceLoader *loader, OH_AVMediaSourceLoaderOnSourceClosedCallback callback, void *userData)

描述

为OH_AVMediaSourceLoader设置关闭回调函数。

起始版本： 23

参数：

参数项	描述
OH_AVMediaSourceLoader *loader	要设置回调函数的OH_AVMediaSourceLoader实例。
OH_AVMediaSourceLoaderOnSourceClosedCallback callback	要设置的关闭回调函数。
void *userData	回调函数中使用的用户自定义数据。

返回：