Output Formats

Functions

KvlcStatus kvlcGetFirstWriterFormat (int *format)
 
KvlcStatus kvlcGetNextWriterFormat (int currentFormat, int *nextFormat)
 
KvlcStatus kvlcGetWriterName (int format, char *str, unsigned int len)
 
KvlcStatus kvlcGetWriterExtension (int format, char *str, unsigned int len)
 
KvlcStatus kvlcGetWriterDescription (int format, char *str, unsigned int len)
 
KvlcStatus kvlcIsPropertySupported (int format, unsigned int property, int *supported)
 

Detailed Description

Function Documentation

◆ kvlcGetFirstWriterFormat()

KvlcStatus kvlcGetFirstWriterFormat ( int *  format)

Get the first supported output format.

Parameters
[out]formatFirst output format.
Returns
kvlcOK (zero) if success
kvlcERR_xxx (negative) if failure
See also
kvlcGetNextWriterFormat()

◆ kvlcGetNextWriterFormat()

KvlcStatus kvlcGetNextWriterFormat ( int  currentFormat,
int *  nextFormat 
)

Get the next supported output format.

Parameters
[out]currentFormatCurrent output format.
[out]nextFormatNext output format. Zero if no more formats are to be found.
Returns
kvlcOK (zero) if success
kvlcERR_xxx (negative) if failure
See also
kvlcGetFirstWriterFormat()

◆ kvlcGetWriterDescription()

KvlcStatus kvlcGetWriterDescription ( int  format,
char *  str,
unsigned int  len 
)

Get output converter file description.

Parameters
[in]formatOutput format.
[out]strBuffer to receive description, a pointer to a NULL terminated array of chars.
[in]lenBuffer size in bytes.
Returns
kvlcOK (zero) if success
kvlcERR_xxx (negative) if failure
See also
kvlcGetFirstWriterFormat()

◆ kvlcGetWriterExtension()

KvlcStatus kvlcGetWriterExtension ( int  format,
char *  str,
unsigned int  len 
)

Get output converter file extension.

Parameters
[in]formatOutput format.
[out]strBuffer to receive extension, a pointer to a NULL terminated array of chars.
[in]lenBuffer size in bytes.
Returns
kvlcOK (zero) if success
kvlcERR_xxx (negative) if failure
See also
kvlcGetFirstWriterFormat()

◆ kvlcGetWriterName()

KvlcStatus kvlcGetWriterName ( int  format,
char *  str,
unsigned int  len 
)

Get output converter name.

Parameters
[in]formatOutput format.
[out]strBuffer to receive name, a pointer to a NULL terminated array of chars.
[in]lenBuffer size in bytes.
Returns
kvlcOK (zero) if success
kvlcERR_xxx (negative) if failure
See also
kvlcGetFirstWriterFormat()

◆ kvlcIsPropertySupported()

KvlcStatus kvlcIsPropertySupported ( int  format,
unsigned int  property,
int *  supported 
)

Check if property is supported by output format.

Parameters
[in]formatOutput format, use FILE_FORMAT_xxx.
[out]propertyProperty, use PROPERTY_xxx.
[in]supportedNot zero if format supports property.
Returns
kvlcOK (zero) if success
kvlcERR_xxx (negative) if failure
See also
kvlcGetFirstWriterFormat()