ast_format_interface Struct Reference

Optional format interface to extend format operations. More...

#include <format.h>

Collaboration diagram for ast_format_interface:

Data Fields
const void *(*const	format_attribute_get )(const struct ast_format *format, const char *name)
	Retrieve a particular format attribute setting.
struct ast_format *(*const	format_attribute_set )(const struct ast_format *format, const char *name, const char *value)
	Set an attribute on a format.
int(*const	format_clone )(const struct ast_format *src, struct ast_format *dst)
	Callback for when the format is cloned, used to clone attributes.
enum ast_format_cmp_res(*const	format_cmp )(const struct ast_format *format1, const struct ast_format *format2)
	Determine if format 1 is a subset of format 2.
void(*const	format_destroy )(struct ast_format *format)
	Callback for when the format is destroyed, used to release attribute resources.
void(*const	format_generate_sdp_fmtp )(const struct ast_format *format, unsigned int payload, struct ast_str **str)
	Generate SDP attribute information from an ast_format structure.
struct ast_format *(*const	format_get_joint )(const struct ast_format *format1, const struct ast_format *format2)
	Get a format with the joint compatible attributes of both provided formats.
struct ast_format *(*const	format_parse_sdp_fmtp )(const struct ast_format *format, const char *attributes)
	Parse SDP attribute information, interpret it, and store it in the format structure.

Detailed Description

Optional format interface to extend format operations.

Definition at line 44 of file format.h.

Field Documentation

format_attribute_get

const void *(*const format_attribute_get) (const struct ast_format *format, const char *name)

Retrieve a particular format attribute setting.

Since

13.6.0

Parameters

format	The format containing attributes
name	The name of the attribute to retrieve

Return values

NULL	if the parameter is not set on the format
non-NULL	the format attribute value

Definition at line 134 of file format.h.

Referenced by ast_format_attribute_get().

format_attribute_set

struct ast_format *(*const format_attribute_set) (const struct ast_format *format, const char *name, const char *value)

Set an attribute on a format.

Parameters

name	The name of the attribute
value	The value of the attribute

Return values

non-NULL	success
NULL	failure

Definition at line 61 of file format.h.

format_clone

int(*const format_clone) (const struct ast_format *src, struct ast_format *dst)

Callback for when the format is cloned, used to clone attributes.

Parameters

src	Source format of attributes
dst	Destination format for attributes

Return values

0	success
-1	failure

Definition at line 61 of file format.h.

Referenced by __ast_format_interface_register(), and ast_format_clone().

format_cmp

enum ast_format_cmp_res(*const format_cmp) (const struct ast_format *format1, const struct ast_format *format2)

Determine if format 1 is a subset of format 2.

Parameters

format1	First format to compare
format2	Second format which the first is compared against

Returns

ast_format_cmp_res representing the result of comparing format1 and format2.

Definition at line 61 of file format.h.

Referenced by ast_format_cmp().

format_destroy

void(*const format_destroy) (struct ast_format *format)

Callback for when the format is destroyed, used to release attribute resources.

Parameters

format

The format structure to destroy

Definition at line 50 of file format.h.

Referenced by __ast_format_interface_register(), and format_destroy().

format_generate_sdp_fmtp

void(*const format_generate_sdp_fmtp) (const struct ast_format *format, unsigned int payload, struct ast_str **str)

Generate SDP attribute information from an ast_format structure.

Parameters

format	The format containing attributes
payload	The payload number to place into the fmtp line
str	The generated fmtp line

Note

This callback should generate a full fmtp line using the provided payload number.

Definition at line 121 of file format.h.

Referenced by ast_format_generate_sdp_fmtp().

format_get_joint

struct ast_format *(*const format_get_joint) (const struct ast_format *format1, const struct ast_format *format2)

Get a format with the joint compatible attributes of both provided formats.

Parameters

format1	The first format
format2	The second format

Return values

non-NULL	if joint format
NULL	if no joint format

Note

The returned format has its reference count incremented and must be released using ao2_ref or ao2_cleanup.

Definition at line 61 of file format.h.

format_parse_sdp_fmtp

struct ast_format *(*const format_parse_sdp_fmtp) (const struct ast_format *format, const char *attributes)

Parse SDP attribute information, interpret it, and store it in the format structure.

Parameters

format	Format to set attributes on
attributes	A string containing only the attributes from the fmtp line

Return values

non-NULL	Success, values were valid
NULL	Failure, some values were not acceptable

Definition at line 61 of file format.h.

Referenced by ast_format_parse_sdp_fmtp().

---

The documentation for this struct was generated from the following file:

• format.h