# Format - [Overview](#section343241842165623) - [Summary](#section394624958165623) - [Files](#files) - [Data Structures](#nested-classes) - [Macros](#define-members) - [Typedefs](#typedef-members) - [Enumerations](#enum-members) - [Functions](#func-members) - [Details](#section1693197691165623) - [Macro Definition](#section935031532165623) - [FORMAT\_INVALID\_PROGRAM\_ID](#gab4007b017f1edad143959af034e32bf7) - [FORMAT\_INVALID\_TRACK\_ID](#ga62037bb16334896e1bb6d35a71618881) - [FORMAT\_LANGUAGE\_LEN](#gaa70508bb1089c99f9aa3d59fcbdfa8eb) - [FORMAT\_MAX\_LANGUAGE\_NUM](#gac2d2d077edb8e9bb9f85ab6350015c5b) - [FORMAT\_TITLE\_LEN](#gadb635fac84a9d62e99c69e75d4de85c3) - [URL\_LEN](#ga1ac54dd3b9b49c1800b5f502a87650be) - [Typedef](#section545940743165623) - [CALLBACK\_HANDLE](#gab928f39c359734527bda3fd160f89331) - [Enumeration Type](#section1904403459165623) - [AudioSampleFmt](#gadf0700999998f587f0017c4d02977b22) - [CodecFormat](#gaf7ed135f15d4b218d41705bac0122ba7) - [DataFlags](#gacff079fdf8427c743f9197ea5be33a7f) - [FormatErrorType](#ga31e7fcf42722fa15e4e5489c2fef9092) - [FormatInfoType](#ga6f00342925d3d5e586c76f8695985cad) - [FormatSeekMode](#ga14aa9d18a71eff4a0b70f748f0377c94) - [FrameType](#gad495a9f61af7fff07d7e97979d1ab854) - [KeyType](#gaab0feaba617470cb4aa830dc5935238c) - [ManualSplitType](#ga10d9833450f29129d249c41d9acb4bc4) - [OutputFormat](#gaeb712c6c6c0a8af0dfd79f451ecb9277) - [OutputType](#ga4e0517338e6c4a31a2addafc06d4f3a3) - [SourceType](#ga3ae727773c367ac1041d72ac770a0ab1) - [SubtitleFormat](#gadac45ce4731516c262292c15433439b3) - [SubtitleFrameType](#ga43b7f046e365a89697272d850b0517b7) - [TrackSourceType](#ga953bc46f95d7b2d8866838d792f8f6aa) - [TrackType](#gad80740dd555f7d3688d2c4d9f44d3b04) - [Function](#section1772238272165623) - [FormatDeInit\(\)](#gabb574933ebb4f3d1d2ed299e79aeee2c) - [FormatDemuxerCreate\(\)](#ga183fbc31f2c9877ef56464abcccef374) - [FormatDemuxerDestory\(\)](#ga98fd9a5a5d1ffd275fc46f898ca08413) - [FormatDemuxerFreeFrame\(\)](#ga291b805de194c695b72eb5ad721103d5) - [FormatDemuxerGetBufferConfig\(\)](#ga565cbb52c95a95aab4dcc957fe998b5f) - [FormatDemuxerGetFileInfo\(\)](#gad807d61c65e89629c7eed8f97426fd5a) - [FormatDemuxerGetParameter\(\)](#ga6c2a1aa9fdf1db8e2f14a3a92ffa23d5) - [FormatDemuxerGetSelectedTrack\(\)](#gab6ef68051ee2ed0015e721bedb1af61c) - [FormatDemuxerPrepare\(\)](#gacfcf40d869a48125bd67d17f8a4fc3ce) - [FormatDemuxerReadFrame\(\)](#ga7b20e1b88413d20a348d7f796917cd94) - [FormatDemuxerSeek\(\)](#gad53f1e848f3c2e0c8fa056a312b2ed6c) - [FormatDemuxerSelectTrack\(\)](#ga1d9cb94614e207def34f13eaa16ef2b7) - [FormatDemuxerSetBufferConfig\(\)](#gad2a15f3fa640f3f9e8e684d71b3a12cb) - [FormatDemuxerSetCallBack\(\)](#ga9ef126fc3132b556d49a275799e7753b) - [FormatDemuxerSetParameter\(\)](#ga92d859ba4745ce26b94595daaa40462d) - [FormatDemuxerStart\(\)](#ga08544b1ba3373bf5cb211586e8195673) - [FormatDemuxerStop\(\)](#ga8a693d8be0b4b688d99e513608884e91) - [FormatDemuxerUnselectTrack\(\)](#gaf5fd5bab9613d133827054f157d5520e) - [FormatInit\(\)](#gae10a50c8f3de6e54ee0dc3937f755920) - [FormatMuxerAddTrack\(\)](#ga94e9ab3e534b69a358b7cc16e4f79b78) - [FormatMuxerCreate\(\)](#ga9c390276cb90f4753c32af5aa5c600ad) - [FormatMuxerDestory\(\)](#gaa41d46cef6d5e81c85614edbf824d803) - [FormatMuxerGetParameter\(\)](#ga67dd7361dedf335496afef19d54e4138) - [FormatMuxerSetCallBack\(\)](#ga108cd7e319ade568f71890d57585f153) - [FormatMuxerSetFileSplitDuration\(\)](#ga6eed6b5e7522e102f2d79d0dd33fd2a9) - [FormatMuxerSetLocation\(\)](#ga967ba14fa1231eed2942b87a09deb953) - [FormatMuxerSetMaxFileDuration\(\)](#gae931061d822c4ffe447e9ba40a991597) - [FormatMuxerSetMaxFileSize\(\)](#ga6f3ba422c9bbca4c1d5a7a3fe85dd9b9) - [FormatMuxerSetNextOutputFile\(\)](#gaa936b56996294d76977537267fef058c) - [FormatMuxerSetOrientation\(\)](#ga96fc57913c3202d2d23704c69d660be5) - [FormatMuxerSetParameter\(\)](#gad4335ebaa7c165b885a00fe61aae0cd9) - [FormatMuxerStart\(\)](#ga9a2af831a6f4a63dc85d2c23b5c7c81b) - [FormatMuxerStop\(\)](#ga66a3a5a1ec6d01fcbd6339f7eee1151b) - [FormatMuxerWriteFrame\(\)](#ga82037d271e77da206e16582e774ee048) ## **Overview** **Description:** Defines format-related APIs. For example, you use this module to define custom data types and to initialize, create, destroy the muxer and demuxer, and set their parameters. Also, you can read demuxer data frames, select demuxer tracks, add muxer tracks, and write data frames into a container. **Since:** 1.0 **Version:** 1.0 ## **Summary** ## Files

File Name

Description

format_interface.h

Declares format-related APIs.

format_type.h

Declares format-related structures and enumerations, including custom data types for file information, programs, information about audio and video subtitle tracks, source data types, output data types, split types, and data frames.

parameter_item.h

Defines format-related structures and enumerations used to configure and obtain dynamic parameters.

## Data Structures

Data Structure Name

Description

FormatBufferSetting

Defines the buffer configuration.

FormatFrame

Defines the data frame, which is used for data transferring.

AudioTrackInfo

Defines audio track information.

VideoTrackInfo

Defines video track information.

SubImageInfo

Defines image information.

ImageTrackInfo

Defines image stream information.

SubtitleTrackInfo

Defines subtitle stream information.

TrackInfo

Defines track information.

ProgramInfo

Defines program information.

FileInfo

Defines movie file information.

BufferStream

Defines the function for reading stream data.

FormatSource

Defines the demuxer data source.

FormatOutputConfig

Defines the muxer output configuration.

VideoTrackSourceInfo

Defines information about the muxer video source.

AudioTrackSourceInfo

Defines information about the muxer audio source.

DataTrackSourceInfo

Defines information about the muxer data source.

TrackSource

Defines information about the muxer source.

FormatCallback

Defines listener callbacks for the format.

ParameterItem

Defines a structure for configuring and obtaining dynamic parameters.

## Macros

Macro Name and Value

Description

FORMAT_MAX_LANGUAGE_NUM 4

  

FORMAT_LANGUAGE_LEN 4

  

FORMAT_TITLE_LEN 64

  

FORMAT_INVALID_TRACK_ID -1

  

FORMAT_INVALID_PROGRAM_ID -1

  

URL_LEN 4096

  
## Typedefs

Typedef Name

Description

CALLBACK_HANDLE

typedef void *

Indicates the pointer to the callback handle for listening the muxer.

## Enumerations

Enumeration Name

Description

FrameType { FRAME_TYPE_NONE, FRAME_TYPE_AUDIO, FRAME_TYPE_VIDEO, FRAME_TYPE_IMAGE, FRAME_TYPE_SUB, FRAME_TYPE_DATA, FRAME_TYPE_BUT }

Enumerates data frame types.

FormatSeekMode { FORMAT_SEEK_MODE_FORWARD_KEY, FORMAT_SEEK_MODE_BACKWARD_KEY, FORMAT_SEEK_MODE_CLOSEST_KEY, SEEK_MODE_BUT }

Enumerates seek modes.

CodecFormat { CODEC_H264 = 0, CODEC_H265, CODEC_JPEG, CODEC_AAC, CODEC_G711A, CODEC_G711U, CODEC_PCM, CODEC_MP3, CODEC_BUT }

Enumerates audio, video, and image encoding formats.

AudioSampleFmt { AUDIO_SAMPLE_FMT_S8 = 0, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S24, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT }

Enumerates audio sampling formats.

SubtitleFrameType { HI_SVR_SUBTITLE_BITMAP = 0x0, HI_SVR_SUBTITLE_TEXT }

Enumerates subtitle frame types.

SubtitleFormat { FORMAT_SUB_ASS = 0x0, FORMAT_SUB_LRC, FORMAT_SUB_SRT, FORMAT_SUB_SMI, FORMAT_SUB_SUB, FORMAT_SUB_TXT, FORMAT_SUB_HDMV_PGS, FORMAT_SUB_DVB_SUB, FORMAT_SUB_DVD_SUB, FORMAT_SUB_TTML, FORMAT_SUB_WEBVTT, FORMAT_SUB_BUTT }

Enumerates subtitle file formats.

TrackType { TRACK_TYPE_VIDEO, TRACK_TYPE_AUDIO, TRACK_TYPE_IMAGE, TRACK_TYPE_SUB, TRACK_TYPE_DATA, TRACK_TYPE_BUT }

Enumerates track types.

DataFlags { DATA_FLAG_NONE = 0, DATA_FLAG_SYNCFRAME = 1, DATA_FLAG_CODECCONFIG = 2, DATA_FLAG_EOS = 4, DATA_FLAG_PARTIAL_FRAME = 8, DATA_FLAG_ENDOFFRAME = 16, DATA_FLAG_MUXER_DATA = 32 }

Enumerates flags of raw stream data.

SourceType { SOURCE_TYPE_FD = 0, SOURCE_TYPE_URI, SOURCE_TYPE_STREAM, SOURCE_TYPE_BUT }

Enumerates types of the demuxer data source.

OutputFormat { OUTPUT_FORMAT_MPEG_4 = 0, OUTPUT_FORMAT_TS = 1, OUTPUT_FORMAT_THREE_GPP = 2, OUTPUT_FORMAT_HEIF = 3, OUTPUT_FORMAT_OGG = 4, OUTPUT_FORMAT_INVALID }

Enumerates output file formats.

FormatInfoType { MUXER_INFO_MAX_DURATION_APPROACHING = 0, MUXER_INFO_MAX_FILESIZE_APPROACHING, MUXER_INFO_MAX_DURATION_REACHED, MUXER_INFO_MAX_FILESIZE_REACHED, MUXER_INFO_NEXT_OUTPUT_FILE_STARTED, MUXER_INFO_FILE_SPLIT_FINISHED, MUXER_INFO_FILE_START_TIME_MS, DEMUXER_INFO_PREPARED = 10000, DEMUXER_INFO_SEEK_COMPLETE, DEMUXER_INFO_NETWORK_DISCONNECTED, DEMUXER_INFO_NETWORK_RECONNECTED }

Enumerates types of callback information.

FormatErrorType

Enumerates callback error types.

OutputType { OUTPUT_TYPE_FD = 0, OUTPUT_TYPE_URI, OUTPUT_TYPE_INVALID }

Enumerates muxer output types.

ManualSplitType { MANUAL_SPLIT_POST = 0, MANUAL_SPLIT_PRE, MANUAL_SPLIT_NORMAL }

Enumerates manual split types for the muxer.

TrackSourceType { TRACK_SOURCE_TYPE_VIDEO = 0, TRACK_SOURCE_TYPE_AUDIO, TRACK_SOURCE_TYPE_DATA, TRACK_SOURCE_TYPE_INVALID }

Enumerates types of the muxer source track.

KeyType { KEY_TYPE_MIME = 0x6d696d65, KEY_TYPE_HTTP_HEADERS = 0x68706864, KEY_TYPE_LANGUAGE = 0x6c616e67, KEY_TYPE_PRE_CACHE = 0x70726361 }

Enumerates key types used for setting and obtaining parameters.

## Functions

Function

Description

FormatInit (void)

void

Initializes the format.

FormatDeInit (void)

void

Deinitializes the format.

FormatDemuxerCreate (const FormatSource *source, void **handle)

int32_t

Creates a demuxer component and returns its context handle.

FormatDemuxerSetParameter (const void *handle, int32_t trackId, const ParameterItem *metaData, int32_t metaDataCnt)

int32_t

Sets demuxer attributes.

FormatDemuxerGetParameter (const void *handle, int32_t trackId, ParameterItem *metaData)

int32_t

Obtains demuxer attributes.

FormatDemuxerSetCallBack (void *handle, const FormatCallback *callBack)

int32_t

Sets a callback for the demuxer.

FormatDemuxerSetBufferConfig (void *handle, const FormatBufferSetting *setting)

int32_t

Sets buffer information for the demuxer.

FormatDemuxerGetBufferConfig (const void *handle, FormatBufferSetting *setting)

int32_t

Obtains the buffer information of the demuxer.

FormatDemuxerPrepare (void *handle)

int32_t

Makes preparations for the demuxer.

FormatDemuxerGetFileInfo (void *handle, FileInfo *info)

int32_t

Obtains the attributes of a media file.

FormatDemuxerSelectTrack (const void *handle, int32_t programId, int32_t trackId)

int32_t

Selects a specified media track.

FormatDemuxerUnselectTrack (const void *handle, int32_t programId, int32_t trackId)

int32_t

Unselects a specified media track from which the demuxer reads data frames.

FormatDemuxerStart (void *handle)

int32_t

Starts the demuxer.

FormatDemuxerGetSelectedTrack (const void *handle, int32_t *programId, int32_t trackId[], int32_t *nums)

int32_t

Obtains the ID of the media track selected by the demuxer for output.

FormatDemuxerReadFrame (const void *handle, FormatFrame *frame, int32_t timeOutMs)

int32_t

Reads data frames.

FormatDemuxerFreeFrame (void *handle, FormatFrame *frame)

int32_t

Frees data frames.

FormatDemuxerSeek (const void *handle, int32_t streamIndex, int64_t timeStampUs, FormatSeekMode mode)

int32_t

Seeks for a specified position for the demuxer.

FormatDemuxerStop (void *handle)

int32_t

Stops the demuxer from working.

FormatDemuxerDestory (void *handle)

int32_t

Destroys demuxer resources.

FormatMuxerCreate (void **handle, FormatOutputConfig *outputConfig)

int32_t

Creates a muxer and returns its context handle.

FormatMuxerDestory (const void *handle)

int32_t

Destroys a muxer and release its resources created by calling FormatMuxerCreate.

FormatMuxerAddTrack (void *handle, const TrackSource *trackSource)

int32_t

Adds a media track source for the muxer. For details about track sources, see TrackSource.

FormatMuxerSetCallBack (void *handle, const FormatCallback *callBack)

int32_t

Sets a callback for the muxer. For details about the callback, see FormatCallback.

FormatMuxerSetOrientation (void *handle, int degrees)

int32_t

Sets the orientation of the video track for the muxer.

FormatMuxerSetLocation (const void *handle, int latitude, int longitude)

int32_t

Sets the geographical information for the output file of the muxer.

FormatMuxerSetMaxFileSize (void *handle, int64_t bytes)

int32_t

Sets the maximum size (in bytes) for the output file of the muxer.

FormatMuxerSetMaxFileDuration (void *handle, int64_t durationUs)

int32_t

Sets the maximum duration (in seconds) for the output file.

FormatMuxerSetFileSplitDuration (const void *handle, ManualSplitType type, int64_t timestampUs, uint32_t durationUs)

int32_t

Manually splits a file.

FormatMuxerStart (void *handle)

int32_t

Starts the muxer.

FormatMuxerWriteFrame (const void *handle, const FormatFrame *frameData)

int32_t

Writes data frames into the muxer.

FormatMuxerSetNextOutputFile (const void *handle, int32_t fd)

int32_t

Sets the descriptor for the next output file.

FormatMuxerStop (const void *handle, bool block)

int32_t

Stops the muxer that was started by calling FormatMuxerStart.

FormatMuxerSetParameter (void *handle, int32_t trackId, const ParameterItem *item, int32_t itemNum)

int32_t

Sets muxer attributes.

FormatMuxerGetParameter (void *handle, int32_t trackId, ParameterItem *item, int32_t itemNum)

int32_t

Obtains muxer attributes.

## **Details** ## **Macro Definition ** ## FORMAT\_INVALID\_PROGRAM\_ID ``` #define FORMAT_INVALID_PROGRAM_ID -1 ``` **Description:** Indicates an invalid program ID. ## FORMAT\_INVALID\_TRACK\_ID ``` #define FORMAT_INVALID_TRACK_ID -1 ``` **Description:** Indicates an invalid track ID. ## FORMAT\_LANGUAGE\_LEN ``` #define FORMAT_LANGUAGE_LEN 4 ``` **Description:** Indicates the number of characters contained in the language description. ## FORMAT\_MAX\_LANGUAGE\_NUM ``` #define FORMAT_MAX_LANGUAGE_NUM 4 ``` **Description:** Indicates the number of languages in the subtitle file. ## FORMAT\_TITLE\_LEN ``` #define FORMAT_TITLE_LEN 64 ``` **Description:** Indicates the number of title characters. ## URL\_LEN ``` #define URL_LEN 4096 ``` **Description:** Indicates the URL length. ## **Typedef ** ## CALLBACK\_HANDLE ``` typedef void* [CALLBACK_HANDLE](format.md#gab928f39c359734527bda3fd160f89331) ``` **Description:** Indicates the pointer to the callback handle for listening the muxer. ## **Enumeration Type ** ## AudioSampleFmt ``` enum [AudioSampleFmt](format.md#gadf0700999998f587f0017c4d02977b22) ``` **Description:** Enumerates audio sampling formats.

Enumerator

Description
AUDIO_SAMPLE_FMT_S8

8-bit integer for a single sample

AUDIO_SAMPLE_FMT_S16

16-bit integer for a single sample

AUDIO_SAMPLE_FMT_S24

24-bit integer for a single sample

AUDIO_SAMPLE_FMT_S32

32-bit integer for a single sample

AUDIO_SAMPLE_FMT_FLOAT

Single-precision floating point number for a single sample

## CodecFormat ``` enum [CodecFormat](format.md#gaf7ed135f15d4b218d41705bac0122ba7) ``` **Description:** Enumerates audio, video, and image encoding formats.

Enumerator

Description
CODEC_H264

H264 or AVC

CODEC_H265

H265 or HEVC

CODEC_JPEG

JPEG

CODEC_AAC

AAC

CODEC_G711A

G711A

CODEC_G711U

G711u

CODEC_PCM

PCM

CODEC_MP3

MP3

CODEC_BUT

Undefined format

## DataFlags ``` enum [DataFlags](format.md#gacff079fdf8427c743f9197ea5be33a7f) ``` **Description:** Enumerates flags of raw stream data.

Enumerator

Description
DATA_FLAG_NONE

None

DATA_FLAG_SYNCFRAME

Synchronization frame

DATA_FLAG_CODECCONFIG

Codec configuration information

DATA_FLAG_EOS

End of a single stream

DATA_FLAG_PARTIAL_FRAME

Partial synchronization frame. This flag is used for multiple segments (except for the last one) into which a single frame is divided.

DATA_FLAG_ENDOFFRAME

End of a frame. This flag is used in pair with DATA_FLAG_PARTIAL_FRAME for the last segment of the frame.

DATA_FLAG_MUXER_DATA

Encapsulated data with its container

## FormatErrorType ``` enum [FormatErrorType](format.md#ga31e7fcf42722fa15e4e5489c2fef9092) ``` **Description:** Enumerates callback error types. ## FormatInfoType ``` enum [FormatInfoType](format.md#ga6f00342925d3d5e586c76f8695985cad) ``` **Description:** Enumerates types of callback information.

Enumerator

Description
MUXER_INFO_MAX_DURATION_APPROACHING

The capturing duration is reaching the threshold specified by FormatMuxerSetMaxFileDuration. This information is reported when only one second or 10% is left to reach the allowed duration.

MUXER_INFO_MAX_FILESIZE_APPROACHING

The captured file size is reaching the threshold specified by FormatMuxerSetMaxFileSize. This information is reported when only 100 KB or 10% is left to reach the allowed size.

MUXER_INFO_MAX_DURATION_REACHED

The capturing duration reached the threshold specified by FormatMuxerSetMaxFileDuration, and the capturing is ended. If the file is set by a file descriptor, the caller needs to close the file.

MUXER_INFO_MAX_FILESIZE_REACHED

The captured file size reached the threshold specified by FormatMuxerSetMaxFileSize, and the capturing is ended. If the file is set by a file descriptor, the caller needs to close the file.

MUXER_INFO_NEXT_OUTPUT_FILE_STARTED

The capturing started for the next output file.

MUXER_INFO_FILE_SPLIT_FINISHED

Manual file split is completed.

MUXER_INFO_FILE_START_TIME_MS

Start time of the captured file

DEMUXER_INFO_PREPARED

The prepare function is asynchronously executed. This information is reported after the execution is complete.

DEMUXER_INFO_SEEK_COMPLETE

The seek function is asynchronously executed. This information is reported after the execution is complete.

DEMUXER_INFO_NETWORK_DISCONNECTED

The network is disconnected during network playback.

DEMUXER_INFO_NETWORK_RECONNECTED

The network is automatically reconnected during network playback.

## FormatSeekMode ``` enum [FormatSeekMode](format.md#ga14aa9d18a71eff4a0b70f748f0377c94) ``` **Description:** Enumerates seek modes.

Enumerator

Description
FORMAT_SEEK_MODE_FORWARD_KEY

Seeks forwards for the keyframe closest to specified position.

FORMAT_SEEK_MODE_BACKWARD_KEY

Seeks backwards for the keyframe closest to specified position.

FORMAT_SEEK_MODE_CLOSEST_KEY

Seeks for the keyframe closest to specified position.

SEEK_MODE_BUT

Undefined mode

## FrameType ``` enum [FrameType](format.md#gad495a9f61af7fff07d7e97979d1ab854) ``` **Description:** Enumerates data frame types.

Enumerator

Description
FRAME_TYPE_NONE

Unknown type, which can be used for transport stream (TS) packets

FRAME_TYPE_AUDIO

Audio frame

FRAME_TYPE_VIDEO

Video frame

FRAME_TYPE_IMAGE

Image frame

FRAME_TYPE_SUB

Subtitle frame

FRAME_TYPE_DATA

Data

FRAME_TYPE_BUT

Undefined type

## KeyType ``` enum [KeyType](format.md#gaab0feaba617470cb4aa830dc5935238c) ``` **Description:** Enumerates key types used for setting and obtaining parameters.

Enumerator

Description
KEY_TYPE_MIME

MIME type. The value type is cstring.

KEY_TYPE_HTTP_HEADERS

HTTP header. The value type is cstring.

KEY_TYPE_LANGUAGE

Track language, which is usually the language of audio and subtitles. The value type is cstring.

KEY_TYPE_PRE_CACHE

Precapture cache size. The value type is int

## ManualSplitType ``` enum [ManualSplitType](format.md#ga10d9833450f29129d249c41d9acb4bc4) ``` **Description:** Enumerates manual split types for the muxer.

Enumerator

Description
MANUAL_SPLIT_POST

Search forwards from the current I-frame and split the file at the closest I-frame.

MANUAL_SPLIT_PRE

Search backwards from the current I-frame and split the file at the closest I-frame.

MANUAL_SPLIT_NORMAL

Normal split

## OutputFormat ``` enum [OutputFormat](format.md#gaeb712c6c6c0a8af0dfd79f451ecb9277) ``` **Description:** Enumerates output file formats.

Enumerator

Description
OUTPUT_FORMAT_MPEG_4

MP4

OUTPUT_FORMAT_TS

TS

OUTPUT_FORMAT_THREE_GPP

3GPP

OUTPUT_FORMAT_HEIF

HEIF

OUTPUT_FORMAT_OGG

Ogg

OUTPUT_FORMAT_INVALID

Invalid format

## OutputType ``` enum [OutputType](format.md#ga4e0517338e6c4a31a2addafc06d4f3a3) ``` **Description:** Enumerates muxer output types.

Enumerator

Description
OUTPUT_TYPE_FD

File descriptor

OUTPUT_TYPE_URI

Local file URI

OUTPUT_TYPE_INVALID

Undefined type

## SourceType ``` enum [SourceType](format.md#ga3ae727773c367ac1041d72ac770a0ab1) ``` **Description:** Enumerates types of the demuxer data source.

Enumerator

Description
SOURCE_TYPE_FD

File descriptor

SOURCE_TYPE_URI

URI, which can be a network address or a local file path

SOURCE_TYPE_STREAM

Streams

SOURCE_TYPE_BUT

Undefined source

## SubtitleFormat ``` enum [SubtitleFormat](format.md#gadac45ce4731516c262292c15433439b3) ``` **Description:** Enumerates subtitle file formats.

Enumerator

Description
FORMAT_SUB_ASS

ASS

FORMAT_SUB_LRC

LRC

FORMAT_SUB_SRT

SRT

FORMAT_SUB_SMI

SMI

FORMAT_SUB_SUB

SUB

FORMAT_SUB_TXT

RAW UTF-8

FORMAT_SUB_HDMV_PGS

HDMV PGS

FORMAT_SUB_DVB_SUB

DVB

FORMAT_SUB_DVD_SUB

DVD

FORMAT_SUB_TTML

TTML

FORMAT_SUB_WEBVTT

WebVTT

FORMAT_SUB_BUTT

Undefined format

## SubtitleFrameType ``` enum [SubtitleFrameType](format.md#ga43b7f046e365a89697272d850b0517b7) ``` **Description:** Enumerates subtitle frame types.

Enumerator

Description
HI_SVR_SUBTITLE_BITMAP

Bitmap (BMP)

HI_SVR_SUBTITLE_TEXT

Text

## TrackSourceType ``` enum [TrackSourceType](format.md#ga953bc46f95d7b2d8866838d792f8f6aa) ``` **Description:** Enumerates types of the muxer source track.

Enumerator

Description
TRACK_SOURCE_TYPE_VIDEO

Video track

TRACK_SOURCE_TYPE_AUDIO

Audio track

TRACK_SOURCE_TYPE_DATA

Data track

TRACK_SOURCE_TYPE_INVALID

Invalid type

## TrackType ``` enum [TrackType](format.md#gad80740dd555f7d3688d2c4d9f44d3b04) ``` **Description:** Enumerates track types.

Enumerator

Description
TRACK_TYPE_VIDEO

Video track

TRACK_TYPE_AUDIO

Audio track

TRACK_TYPE_IMAGE

Image track

TRACK_TYPE_SUB

Subtitle track

TRACK_TYPE_DATA

Data track

TRACK_TYPE_BUT

Undefined track

## **Function ** ## FormatDeInit\(\) ``` void FormatDeInit (void ) ``` **Description:** Deinitializes the format. You can call this function to deinitialize the demuxer and muxer. This function works in pair with [FormatInit](format.md#gae10a50c8f3de6e54ee0dc3937f755920). ## FormatDemuxerCreate\(\) ``` int32_t FormatDemuxerCreate (const [FormatSource](formatsource.md) * source, void ** handle ) ``` **Description:** Creates a demuxer component and returns its context handle. This function returns the demuxer context handle without probing the container format or obtaining stream information. **Parameters:**

Name

Description
source Indicates the pointer to the format source of the demuxer. For details, see FormatSource.
handle Indicates the double pointer to the demuxer context handle.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerDestory\(\) ``` int32_t FormatDemuxerDestory (void * handle) ``` **Description:** Destroys demuxer resources. This function works in pair with [FormatDemuxerCreate](format.md#ga183fbc31f2c9877ef56464abcccef374). If you do not call this function, resource leakage may occur. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerFreeFrame\(\) ``` int32_t FormatDemuxerFreeFrame (void * handle, [FormatFrame](formatframe.md) * frame ) ``` **Description:** Frees data frames. You can call this function to free the data frames obtained by calling [FormatDemuxerReadFrame](format.md#ga7b20e1b88413d20a348d7f796917cd94). **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
frame Indicates the pointer to the data structure FormatFrame.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerGetBufferConfig\(\) ``` int32_t FormatDemuxerGetBufferConfig (const void * handle, [FormatBufferSetting](formatbuffersetting.md) * setting ) ``` **Description:** Obtains the buffer information of the demuxer. If there is a buffer mechanism in the demuxer, you can call this function to obtain the maximum buffer size and time. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
setting Indicates the pointer to the maximum demuxer buffer size and time, as defined in FormatBufferSetting.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerGetFileInfo\(\) ``` int32_t FormatDemuxerGetFileInfo (void * handle, [FileInfo](fileinfo.md) * info ) ``` **Description:** Obtains the attributes of a media file. The attributes contain file, program, and stream attributes. This function should be called after [FormatDemuxerPrepare](format.md#gacfcf40d869a48125bd67d17f8a4fc3ce) is called. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
info Indicates the pointer to the source attributes, as defined in FileInfo.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerGetParameter\(\) ``` int32_t FormatDemuxerGetParameter (const void * handle, int32_t trackId, [ParameterItem](parameteritem.md) * metaData ) ``` **Description:** Obtains demuxer attributes. You can call this function to obtain the HTTP header, HTTP referer, and other extension items for the demuxer after [FormatDemuxerCreate](format.md#ga183fbc31f2c9877ef56464abcccef374) is called. The demuxer will store the value in the **metaData** based on the key.If the demuxer has allocated memory for the **metaData** to store the value, the caller should manually free the memory. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
trackId Identifies the track. If the value is an invalid value (-1), this parameter identifies the file or program.
metaData Indicates the pointer to the buffer for storing the parameters values that the demuxer has searched for based on the input key. For details, see ParameterItem.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerGetSelectedTrack\(\) ``` int32_t FormatDemuxerGetSelectedTrack (const void * handle, int32_t * programId, int32_t trackId[], int32_t * nums ) ``` **Description:** Obtains the ID of the media track selected by the demuxer for output. The demuxer automatically selects the default program and its media tracks. However, if the program and media tracks have changed after [FormatDemuxerSelectTrack](format.md#ga1d9cb94614e207def34f13eaa16ef2b7) and [FormatDemuxerUnselectTrack](format.md#gaf5fd5bab9613d133827054f157d5520e) are called, you can obtain the currently selected program and media tracks by calling this function \(**FormatDemuxerGetSelectedTrack**. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
programId Identifies the pointer to the program.
trackId Identifies the array of selected media tracks. This parameter works in pair with nums.
nums Indicates the pointer to the total number of selected media tracks. This parameter works in pair with trackId.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerPrepare\(\) ``` int32_t FormatDemuxerPrepare (void * handle) ``` **Description:** Makes preparations for the demuxer. This function triggers the demuxer to probe the media file container format and parse stream information. You can obtain media file attributes only after this function is called. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerReadFrame\(\) ``` int32_t FormatDemuxerReadFrame (const void * handle, [FormatFrame](formatframe.md) * frame, int32_t timeOutMs ) ``` **Description:** Reads data frames. After the data frames are read, you need to call **FormatDemuxerFreeFame** to free them. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
frame Indicates the pointer to the data structure FormatFrame.
timeOutMs Indicates the time required for waiting data frame read. The value 0 indicates that data frames are immediately read without any wait.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerSeek\(\) ``` int32_t FormatDemuxerSeek (const void * handle, int32_t streamIndex, int64_t timeStampUs, [FormatSeekMode](format.md#ga14aa9d18a71eff4a0b70f748f0377c94) mode ) ``` **Description:** Seeks for a specified position for the demuxer. After being started, the demuxer seeks for a specified position to read data frames. You can specify the position close to the time specified by **streamIndex**. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
streamIndex Identifies the stream in the media file.
timeStampUs Indicates the target position, in microseconds.
mode Indicates the seek mode, as defined in FormatSeekMode.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerSelectTrack\(\) ``` int32_t FormatDemuxerSelectTrack (const void * handle, int32_t programId, int32_t trackId ) ``` **Description:** Selects a specified media track. The media tracks to select must belong to the same program. If you do not call this function, the default media tracks of the default program are selected. If **programId** is valid but **trackId** is invalid, the default media track of the specified program is used. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
programId Identifies the program.
trackId Identifies the media track. If a valid value is passed, the media track must belong to the specified program. If an invalid value is passed, the default media track of the specified program is used. If multiple audio tracks are specified, the player determines which audio track to use.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerSetBufferConfig\(\) ``` int32_t FormatDemuxerSetBufferConfig (void * handle, const [FormatBufferSetting](formatbuffersetting.md) * setting ) ``` **Description:** Sets buffer information for the demuxer. If there is a buffer mechanism in the demuxer, you can call this function to set the maximum buffer size and time. Alternatively, you can disable the buffer mechanism by setting the buffer size and time to **0** in the **setting** parameter. If there is no buffer mechanism or the default setting is retained, you can skip this function. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
setting Indicates the pointer to the maximum demuxer buffer size and time, as defined in FormatBufferSetting.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerSetCallBack\(\) ``` int32_t FormatDemuxerSetCallBack (void * handle, const [FormatCallback](formatcallback.md) * callBack ) ``` **Description:** Sets a callback for the demuxer. The callback will be invoked to notify the upper layer of internal events of the demuxer. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
callBack Indicates the pointer to the callback, as defined in FormatCallback.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerSetParameter\(\) ``` int32_t FormatDemuxerSetParameter (const void * handle, int32_t trackId, const [ParameterItem](parameteritem.md) * metaData, int32_t metaDataCnt ) ``` **Description:** Sets demuxer attributes. You can call this function to set the HTTP header, HTTP referer, and other extension items for the demuxer after [FormatDemuxerCreate](format.md#ga183fbc31f2c9877ef56464abcccef374) is called. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
trackId Identifies the track. If the value is an invalid value (-1), this parameter identifies the file or program.
metaData Indicates the pointer to an array of key-value pairs representing parameter names and values. For details, see ParameterItem.
metaDataCnt Indicates the number of key-value pairs in the array. This parameter works in pair with metaData.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerStart\(\) ``` int32_t FormatDemuxerStart (void * handle) ``` **Description:** Starts the demuxer. After being started, the caller can read data frames from the demuxer. This function should be called after [FormatDemuxerPrepare](format.md#gacfcf40d869a48125bd67d17f8a4fc3ce) is called. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerStop\(\) ``` int32_t FormatDemuxerStop (void * handle) ``` **Description:** Stops the demuxer from working. After this function is called, the demuxer cannot resume decapsulation. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatDemuxerUnselectTrack\(\) ``` int32_t FormatDemuxerUnselectTrack (const void * handle, int32_t programId, int32_t trackId ) ``` **Description:** Unselects a specified media track from which the demuxer reads data frames. The demuxer can read all media tracks of the default program. You can call this function to unselect all or certain tracks of a specified program that the demuxer is expected not to read. If **trackId** is invalid, the demuxer will read none of the tracks of the specified program. **Parameters:**

Name

Description
handle Indicates the pointer to the demuxer context handle.
programId Identifies the program.
trackId Identifies the media track that the demuxer will unselect. This parameter works in pair with programId. If a valid value is passed, the media track must belong to the program specified by programId. If an invalid value is passed, and all media tracks of the specified program are unselected.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatInit\(\) ``` void FormatInit (void ) ``` **Description:** Initializes the format. You can call this function to initialize the demuxer and muxer. This function should always be called before other format-specific functions, and it can be called only once within a process. ## FormatMuxerAddTrack\(\) ``` int32_t FormatMuxerAddTrack (void * handle, const [TrackSource](tracksource.md) * trackSource ) ``` **Description:** Adds a media track source for the muxer. For details about track sources, see [TrackSource](tracksource.md). This function must be called after [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad) is successfully called and before [FormatMuxerStart](format.md#ga9a2af831a6f4a63dc85d2c23b5c7c81b) is called. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
trackSource Indicates the pointer to the track source.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerCreate\(\) ``` int32_t FormatMuxerCreate (void ** handle, [FormatOutputConfig](formatoutputconfig.md) * outputConfig ) ``` **Description:** Creates a muxer and returns its context handle. **Parameters:**

Name

Description
handle Indicates the double pointer to the muxer context handle.
outputConfig Indicates the pointer to the muxer output configuration, as defined in FormatOutputConfig.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerDestory\(\) ``` int32_t FormatMuxerDestory (const void * handle) ``` **Description:** Destroys a muxer and release its resources created by calling [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad). **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerGetParameter\(\) ``` int32_t FormatMuxerGetParameter (void * handle, int32_t trackId, [ParameterItem](parameteritem.md) * item, int32_t itemNum ) ``` **Description:** Obtains muxer attributes. This is an extended function that can be used to obtain muxer or track attributes. The demuxer then obtains the muxer attributes based on the key contained in **item**. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
trackId Identifies the media track. If the value is FORMAT_INVALID_TRACK_ID, this function obtains the muxer attributes.
item Indicates the pointer to the items carrying muxer attributes. You can specify multiple items at a time in this parameter, which works in pair with itemNum.
itemNum Indicates the number of attributes set at a time.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value if any requested attribute fails to be obtained or is not found. ## FormatMuxerSetCallBack\(\) ``` int32_t FormatMuxerSetCallBack (void * handle, const [FormatCallback](formatcallback.md) * callBack ) ``` **Description:** Sets a callback for the muxer. For details about the callback, see [FormatCallback](formatcallback.md). This function should be called after [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad) is successfully called. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
FormatCallback Indicates the pointer to the muxer callback to set.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerSetFileSplitDuration\(\) ``` int32_t FormatMuxerSetFileSplitDuration (const void * handle, [ManualSplitType](format.md#ga10d9833450f29129d249c41d9acb4bc4) type, int64_t timestampUs, uint32_t durationUs ) ``` **Description:** Manually splits a file. This function can be called after [FormatMuxerStart](format.md#ga9a2af831a6f4a63dc85d2c23b5c7c81b) is called. Once this function is called, the file is split based on the manual split type. After manual split is complete, file split will proceed to use the initially set split type. You can call this function again only after the [MUXER\_INFO\_FILE\_SPLIT\_FINISHED](format.md#gga6f00342925d3d5e586c76f8695985cada3cf56a06f5990ab657d61bd7e57c1783) event is reported. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
type Indicates the file split type, as defined in FileSplitType.
timestamp Indicates the file split timestamp. This parameter is not supported currently. The value �C1 indicates that the file is split at the time this function is called.
duration Indicates the period from the file split time to the time the next output file starts.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerSetLocation\(\) ``` int32_t FormatMuxerSetLocation (const void * handle, int latitude, int longitude ) ``` **Description:** Sets the geographical information for the output file of the muxer. This function should be called after [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad) is successfully called. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
latitude Indicates the latitude, within the range [-90,90].
longitude Indicates the longitude, within the range [-180,180].
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerSetMaxFileDuration\(\) ``` int32_t FormatMuxerSetMaxFileDuration (void * handle, int64_t durationUs ) ``` **Description:** Sets the maximum duration \(in seconds\) for the output file. You need to call this function before calling [FormatMuxerStart](format.md#ga9a2af831a6f4a63dc85d2c23b5c7c81b). If the maximum duration you set is valid and capturing is approaching 90% of that duration or the remaining duration is 1s, the message [MUXER\_INFO\_MAX\_DURATION\_APPROACHING](format.md#gga6f00342925d3d5e586c76f8695985cadaf6214216fd62faa4fc5e20d0d0ba60bf) is reported via **OnInfo** of [FormatCallback](formatcallback.md). If the output file has been set by calling [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad), you need to call [FormatMuxerSetNextOutputFile](format.md#gaa936b56996294d76977537267fef058c) to set the next output file. Otherwise, the current output file will be overwritten when the capturing reaches the maximum duration you set. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
duration Indicates the maximum duration to set, in seconds. If the value is 0 or negative, the operation fails. In this case, the default duration (60 seconds) will be used.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerSetMaxFileSize\(\) ``` int32_t FormatMuxerSetMaxFileSize (void * handle, int64_t bytes ) ``` **Description:** Sets the maximum size \(in bytes\) for the output file of the muxer. This function should be called after [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad) is successfully called. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
bytes Indicates the maximum size of a file, in bytes. If the value is 0 or negative, the operation fails and the maximum size does not take effect. In this case, the maximum size of a single file supported by the current file system is used as the value of this parameter.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerSetNextOutputFile\(\) ``` int32_t FormatMuxerSetNextOutputFile (const void * handle, int32_t fd ) ``` **Description:** Sets the descriptor for the next output file. If [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad) is successfully called and the file descriptor involved is valid, you can call this function \(**FormatMuxerSetNextOutputFile**\) upon receiving the message [MUXER\_INFO\_MAX\_FILESIZE\_APPROACHING](format.md#gga6f00342925d3d5e586c76f8695985cadafc74f41e73f13a29a83b3a13ea6e66e1) or [MUXER\_INFO\_MAX\_DURATION\_APPROACHING](format.md#gga6f00342925d3d5e586c76f8695985cadaf6214216fd62faa4fc5e20d0d0ba60bf). **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
fd Indicates the file descriptor to set.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerSetOrientation\(\) ``` int32_t FormatMuxerSetOrientation (void * handle, int degrees ) ``` **Description:** Sets the orientation of the video track for the muxer. This function should be called after [FormatMuxerAddTrack](format.md#ga94e9ab3e534b69a358b7cc16e4f79b78) is successfully called. The following degrees are supported: 0, 90, 180, and 270. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
degrees Indicates the clockwise angle of the video track.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerSetParameter\(\) ``` int32_t FormatMuxerSetParameter (void * handle, int32_t trackId, const [ParameterItem](parameteritem.md) * item, int32_t itemNum ) ``` **Description:** Sets muxer attributes. This is an extended function that can be used to add MP4-dedicated boxes and tags \(such as **exif**\). **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
trackId Identifies the media track. If the value is FORMAT_INVALID_TRACK_ID, this function sets the muxer attributes.
item Indicates the pointer to the items carrying muxer attributes. You can specify multiple items at a time in this parameter, which works in pair with itemNum.
itemNum Indicates the number of attributes set at a time.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerStart\(\) ``` int32_t FormatMuxerStart (void * handle) ``` **Description:** Starts the muxer. You can call this function to encapsulate media data after the muxer is created, media tracks are added, and related parameters are set. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerStop\(\) ``` int32_t FormatMuxerStop (const void * handle, bool block ) ``` **Description:** Stops the muxer that was started by calling [FormatMuxerStart](format.md#ga9a2af831a6f4a63dc85d2c23b5c7c81b). **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
block Indicates how to stop the muxer. The value true indicates that the muxer is stopped after all buffered data is processed, and false indicates that the buffered data is discarded and the muxer is immediately stopped.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise. ## FormatMuxerWriteFrame\(\) ``` int32_t FormatMuxerWriteFrame (const void * handle, const [FormatFrame](formatframe.md) * frameData ) ``` **Description:** Writes data frames into the muxer. This function should be called after [FormatMuxerCreate](format.md#ga9c390276cb90f4753c32af5aa5c600ad) is successfully called. **Parameters:**

Name

Description
handle Indicates the pointer to the muxer context handle.
frameData Indicates the pointer to the data structure FormatFrame.
**Returns:** Returns **0** if the operation is successful; returns a non-zero value otherwise.