native_avsource.h

Overview

The file declares the APIs for parsing audio and video media data.

File to include: <multimedia/player_framework/native_avsource.h>

Library: libnative_media_avsource.so

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 10

Related module: AVSource

Sample: AVCodec

Summary

Structs

Name	typedef Keyword	Description
OH_AVSource	OH_AVSource	Describes a native object for the media source interface.

Functions

Name	Description
OH_AVSource OH_AVSource_CreateWithDataSource(OH_AVDataSource dataSource)	Creates an OH_AVSource instance with a user-defined data source. You can release the instance by calling OH_AVSource_Destroy. The lifecycle of dataSource must be the same as that of the returned OH_AVSource * pointer.
OH_AVSource OH_AVSource_CreateWithDataSourceExt(OH_AVDataSourceExt dataSource, void *userData)	Creates an OH_AVSource instance with a user-defined data source. You can release the instance by calling OH_AVSource_Destroy. User-defined data can be passed to its callback functions through the userData parameter. The lifecycle of dataSource must be the same as that of the returned OH_AVSource * pointer.
OH_AVSource OH_AVSource_CreateWithURI(char uri)	Creates an OH_AVSource instance based on a URI. You can release the instance by calling OH_AVSource_Destroy. This function supports only HTTP progressive streaming media, but not HLS/DASH streaming media. For HLS/DASH streaming media playback, use the AVPlayer for development.
OH_AVSource *OH_AVSource_CreateWithFD(int32_t fd, int64_t offset, int64_t size)	Creates an OH_AVSource instance based on an FD. You can release the instance by calling OH_AVSource_Destroy. If offset is not the start position of the file or size is not the file size, undefined errors such as creation failure and demultiplexing failure may occur due to incomplete data obtained.
OH_AVErrCode OH_AVSource_Destroy(OH_AVSource *source)	Destroys an OH_AVSource instance and clears internal resources. An instance can be destroyed only once. The destroyed instance cannot be used until it is re-created. You are advised to set the pointer to NULL after the instance is destroyed.
OH_AVFormat OH_AVSource_GetSourceFormat(OH_AVSource source)	Obtains the basic information about a media resource file. You must call OH_AVFormat_Destroy to release the OH_AVFormat instance when its lifecycle ends.
OH_AVFormat OH_AVSource_GetTrackFormat(OH_AVSource source, uint32_t trackIndex)	Obtains the basic information about a track. You must call OH_AVFormat_Destroy to release the OH_AVFormat instance when its lifecycle ends.
OH_AVFormat OH_AVSource_GetCustomMetadataFormat(OH_AVSource source)	Obtains the basic information about custom metadata. You must call OH_AVFormat_Destroy to release the OH_AVFormat instance when its lifecycle ends.

Function Description

OH_AVSource_CreateWithDataSource()

OH_AVSource *OH_AVSource_CreateWithDataSource(OH_AVDataSource *dataSource)

Description

Creates an OH_AVSource instance with a user-defined data source. You can release the instance by calling OH_AVSource_Destroy.
The lifecycle of dataSource must be the same as that of the returned OH_AVSource * pointer.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Parameters

Name	Description
OH_AVDataSource *dataSource	Pointer to user-defined data source.

Returns

Type	Description
OH_AVSource *	Pointer to the OH_AVSource instance created. If the operation fails, NULL is returned. The possible causes of an operation failure are as follows: 1. The value of dataSource is nullptr. 2. The size of the data source is 0. 3. Setting the data source fails. 4. The memory is insufficient. 5. The decoder engine is nullptr. 6. dataSource->readAt == nullptr.

OH_AVSource_CreateWithDataSourceExt()

OH_AVSource *OH_AVSource_CreateWithDataSourceExt(OH_AVDataSourceExt *dataSource, void *userData)

Description

Creates an OH_AVSource instance with a user-defined data source. You can release the instance by calling OH_AVSource_Destroy.
User-defined data can be passed to its callback functions through the userData parameter.
The lifecycle of dataSource must be the same as that of the returned OH_AVSource * pointer.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 20

Parameters

Name	Description
OH_AVDataSourceExt *dataSource	Pointer to the data source struct, which is used to obtain the input data.
void *userData	Pointer to user-defined data.

Returns

Type	Description
OH_AVSource *	Pointer to the OH_AVSource instance created. If the operation fails, NULL is returned. The possible causes of an operation failure are as follows: 1. The value of dataSource is nullptr. 2. The size of the data source is 0. 3. Setting the data source fails. 4. The memory is insufficient. 5. The decoder engine is nullptr. 6. dataSource->readAt == nullptr.

OH_AVSource_CreateWithURI()

OH_AVSource *OH_AVSource_CreateWithURI(char *uri)

Description

Creates an OH_AVSource instance based on a URI. You can release the instance by calling OH_AVSource_Destroy. This function supports only HTTP progressive streaming media, but not HLS/DASH streaming media. For HLS/DASH streaming media playback, use the AVPlayer for development.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 10

Parameters

Name	Description
char *uri	URI of the media resource.

Returns

Type	Description
OH_AVSource *	Pointer to the OH_AVSource instance created. If the operation fails, NULL is returned. The possible causes of an operation failure are as follows: 1. The network is abnormal. 2. The resource is invalid. 3. The file format is not supported. 4. The application configuration is intercepted because it contains plaintext data.

OH_AVSource_CreateWithFD()

OH_AVSource *OH_AVSource_CreateWithFD(int32_t fd, int64_t offset, int64_t size)

Description

Creates an OH_AVSource instance based on an FD. You can release the instance by calling OH_AVSource_Destroy.
If offset is not the start position of the file or size is not the file size, undefined errors such as creation failure and demultiplexing failure may occur due to incomplete data obtained.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 10

Parameters

Name	Description
int32_t fd	FD of a media resource file.
int64_t offset	Position from which data is to read.
int64_t size	File size, in bytes.

Returns

Type	Description
OH_AVSource *	Pointer to the OH_AVSource instance created. If the operation fails, NULL is returned. The possible causes of an operation failure are as follows: 1. The FD is invalid. 2. The offset is not the start position of the file. 3. The size is incorrect. 4. The resource is invalid. 5. The file format is not supported.

OH_AVSource_Destroy()

OH_AVErrCode OH_AVSource_Destroy(OH_AVSource *source)

Description

Destroys an OH_AVSource instance and clears internal resources.

An instance can be destroyed only once. The destroyed instance cannot be used until it is re-created. You are advised to set the pointer to NULL after the instance is destroyed.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 10

Parameters

Name	Description
OH_AVSource *source	Pointer to an OH_AVSource instance.

Returns

Type	Description
OH_AVErrCode	AV_ERR_OK: The operation is successful. AV_ERR_INVALID_VAL: 1. The value of source is nullptr. 2. The value of source does not point to an OH_AVSource instance.

OH_AVSource_GetSourceFormat()

OH_AVFormat *OH_AVSource_GetSourceFormat(OH_AVSource *source)

Description

Obtains the basic information about a media resource file.
You must call OH_AVFormat_Destroy to release the OH_AVFormat instance when its lifecycle ends.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 10

Parameters

Name	Description
OH_AVSource *source	Pointer to an OH_AVSource instance.

Returns

Type	Description
OH_AVFormat *	Basic information about the file. If the operation fails, NULL is returned. The possible causes of an operation failure are as follows: 1. The value of source is nullptr. 2. The pointer is null or does not point to an OH_AVSource instance. 3. The source is not initialized.

OH_AVSource_GetTrackFormat()

OH_AVFormat *OH_AVSource_GetTrackFormat(OH_AVSource *source, uint32_t trackIndex)

Description

Obtains the basic information about a track.
You must call OH_AVFormat_Destroy to release the OH_AVFormat instance when its lifecycle ends.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 10

Parameters

Name	Description
OH_AVSource *source	Pointer to an OH_AVSource instance.
uint32_t trackIndex	Index of the track whose information is to be obtained.

Returns

Type	Description
OH_AVFormat *	Basic information about the track. If the operation fails, NULL is returned. The possible causes of an operation failure are as follows: 1. The value of source is invalid (either nullptr or a pointer to a non-OH_AVSource instance). 2. The track index is out of range. 3. The source is not initialized.

OH_AVSource_GetCustomMetadataFormat()

OH_AVFormat *OH_AVSource_GetCustomMetadataFormat(OH_AVSource *source)

Description

Obtains the basic information about custom metadata.
You must call OH_AVFormat_Destroy to release the OH_AVFormat instance when its lifecycle ends.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 18

Parameters

Name	Description
OH_AVSource *source	Pointer to an OH_AVSource instance.

Returns

Type	Description
OH_AVFormat *	Basic information about the metadata. If the operation fails, NULL is returned. The possible causes of an operation failure are as follows: 1. The value of source is nullptr. 2. The pointer is null or does not point to an OH_AVSource instance. 3. The source is not initialized.