pjmedia_format Struct Reference

#include <format.h>

Data Fields
pj_uint32_t	id
pjmedia_type	type
pjmedia_format_detail_type	detail_type
union {
pjmedia_audio_format_detail   aud
pjmedia_video_format_detail   vid
char   user [1]
}	det

Detailed Description

This structure contains all the information needed to completely describe a media.

Field Documentation

id

pj_uint32_t pjmedia_format::id

The format id that specifies the audio sample or video pixel format. Some well known formats ids are declared in pjmedia_format_id enumeration.

See also

pjmedia_format_id

Referenced by pjmedia_format_init_audio().

type

pjmedia_type pjmedia_format::type

The top-most type of the media, as an information.

Referenced by pjmedia_format_init_audio(), PJMEDIA_PIA_AVG_BPS(), PJMEDIA_PIA_AVG_FSZ(), PJMEDIA_PIA_BITS(), PJMEDIA_PIA_CCNT(), PJMEDIA_PIA_MAX_BPS(), PJMEDIA_PIA_MAX_FSZ(), PJMEDIA_PIA_PTIME(), PJMEDIA_PIA_SPF(), and PJMEDIA_PIA_SRATE().

detail_type

pjmedia_format_detail_type pjmedia_format::detail_type

The type of detail structure in the detail pointer.

Referenced by pjmedia_format_init_audio(), PJMEDIA_PIA_AVG_BPS(), PJMEDIA_PIA_AVG_FSZ(), PJMEDIA_PIA_BITS(), PJMEDIA_PIA_CCNT(), PJMEDIA_PIA_MAX_BPS(), PJMEDIA_PIA_MAX_FSZ(), PJMEDIA_PIA_PTIME(), PJMEDIA_PIA_SPF(), and PJMEDIA_PIA_SRATE().

aud

pjmedia_audio_format_detail pjmedia_format::aud

Detail section for audio format.

Referenced by pjmedia_format_init_audio(), PJMEDIA_PIA_AVG_BPS(), PJMEDIA_PIA_AVG_FSZ(), PJMEDIA_PIA_BITS(), PJMEDIA_PIA_CCNT(), PJMEDIA_PIA_MAX_BPS(), PJMEDIA_PIA_MAX_FSZ(), PJMEDIA_PIA_PTIME(), PJMEDIA_PIA_SPF(), and PJMEDIA_PIA_SRATE().

vid

pjmedia_video_format_detail pjmedia_format::vid

Detail section for video format.

user

char pjmedia_format::user[1]

Reserved area for user-defined format detail.

union { ... } pjmedia_format::det

Detail section to describe the media.

Referenced by pjmedia_format_init_audio(), PJMEDIA_PIA_AVG_BPS(), PJMEDIA_PIA_AVG_FSZ(), PJMEDIA_PIA_BITS(), PJMEDIA_PIA_CCNT(), PJMEDIA_PIA_MAX_BPS(), PJMEDIA_PIA_MAX_FSZ(), PJMEDIA_PIA_PTIME(), PJMEDIA_PIA_SPF(), and PJMEDIA_PIA_SRATE().

---

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

• format.h