Asterisk - The Open Source Telephony Project GIT-master-0644429
|
Optional format interface to extend format operations. More...
#include <format.h>
Data Fields | |
const void *(*const | format_attribute_get )(const struct ast_format *format, const char *name) |
Retrieve a particular format attribute setting. More... | |
struct ast_format *(*const | format_attribute_set )(const struct ast_format *format, const char *name, const char *value) |
Set an attribute on a format. More... | |
int(*const | format_clone )(const struct ast_format *src, struct ast_format *dst) |
Callback for when the format is cloned, used to clone attributes. More... | |
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. More... | |
void(*const | format_destroy )(struct ast_format *format) |
Callback for when the format is destroyed, used to release attribute resources. More... | |
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. More... | |
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. More... | |
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. More... | |
const void *(*const format_attribute_get) (const struct ast_format *format, const char *name) |
Retrieve a particular format attribute setting.
format | The format containing attributes |
name | The name of the attribute to retrieve |
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().
struct ast_format *(*const format_attribute_set) (const struct ast_format *format, const char *name, const char *value) |
Set an attribute on a format.
name | The name of the attribute |
value | The value of the attribute |
non-NULL | success |
NULL | failure |
Definition at line 61 of file format.h.
Referenced by ast_format_attribute_set().
int(*const format_clone) (const struct ast_format *src, struct ast_format *dst) |
Callback for when the format is cloned, used to clone attributes.
src | Source format of attributes |
dst | Destination format for attributes |
0 | success |
-1 | failure |
Definition at line 61 of file format.h.
Referenced by __ast_format_interface_register(), and ast_format_clone().
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.
format1 | First format to compare |
format2 | Second format which the first is compared against |
Definition at line 61 of file format.h.
Referenced by ast_format_cmp().
void(*const format_destroy) (struct ast_format *format) |
Callback for when the format is destroyed, used to release attribute resources.
format | The format structure to destroy |
Definition at line 50 of file format.h.
Referenced by __ast_format_interface_register(), and format_destroy().
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.
format | The format containing attributes |
payload | The payload number to place into the fmtp line |
str | The generated fmtp line |
Definition at line 121 of file format.h.
Referenced by ast_format_generate_sdp_fmtp().
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.
format1 | The first format |
format2 | The second format |
non-NULL | if joint format |
NULL | if no joint format |
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.
format | Format to set attributes on |
attributes | A string containing only the attributes from the fmtp line |
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().