Group PJMEDIA_TYPES

group PJMEDIA_TYPES

Basic PJMEDIA types and operations.

Defines

PJMEDIA_TP_PROTO_HAS_FLAG(TP_PROTO, FLAGS)

Macro helper for checking if a transport protocol contains specific transport and profile flags.

PJMEDIA_TP_PROTO_TRIM_FLAG(TP_PROTO, FLAGS)

Macro helper for excluding specific flags in transport protocol.

PJMEDIA_FOURCC(C1, C2, C3, C4)

Macro for packing format from a four character code, similar to FOURCC.

Typedefs

typedef struct pjmedia_endpt pjmedia_endpt

Opaque declaration of media endpoint.

typedef struct pjmedia_stream pjmedia_stream

Enums

enum pjmedia_type

Top most media type. See also pjmedia_type_name().

Values:

enumerator PJMEDIA_TYPE_NONE

Type is not specified.

enumerator PJMEDIA_TYPE_AUDIO

The media is audio

enumerator PJMEDIA_TYPE_VIDEO

The media is video.

enumerator PJMEDIA_TYPE_APPLICATION

The media is application.

enumerator PJMEDIA_TYPE_UNKNOWN

The media type is unknown or unsupported.

enum pjmedia_tp_proto

Media transport protocol and profile.

Values:

enumerator PJMEDIA_TP_PROTO_NONE

No transport type

enumerator PJMEDIA_TP_PROTO_UNKNOWN

Transport unknown

enumerator PJMEDIA_TP_PROTO_UDP

UDP transport

enumerator PJMEDIA_TP_PROTO_RTP

RTP transport

enumerator PJMEDIA_TP_PROTO_DTLS

DTLS transport

enumerator PJMEDIA_TP_PROFILE_RTCP_FB

RTCP Feedback profile

enumerator PJMEDIA_TP_PROFILE_SRTP

Secure RTP profile

enumerator PJMEDIA_TP_PROFILE_AVP

Audio/video profile

enumerator PJMEDIA_TP_PROTO_RTP_AVP

RTP using A/V profile

enumerator PJMEDIA_TP_PROTO_RTP_SAVP

Secure RTP using A/V profile

enumerator PJMEDIA_TP_PROTO_DTLS_SRTP

Secure RTP using A/V profile and DTLS-SRTP keying

enumerator PJMEDIA_TP_PROTO_RTP_AVPF

RTP using A/V and RTCP feedback profile

enumerator PJMEDIA_TP_PROTO_RTP_SAVPF

Secure RTP using A/V and RTCP feedback profile

enumerator PJMEDIA_TP_PROTO_DTLS_SRTPF

Secure RTP using A/V and RTCP feedback profile and DTLS-SRTP keying

enum pjmedia_dir

Media direction.

Values:

enumerator PJMEDIA_DIR_NONE

None

enumerator PJMEDIA_DIR_ENCODING

Encoding (outgoing to network) stream, also known as capture

enumerator PJMEDIA_DIR_CAPTURE

Same as encoding direction.

enumerator PJMEDIA_DIR_DECODING

Decoding (incoming from network) stream, also known as playback.

enumerator PJMEDIA_DIR_PLAYBACK

Same as decoding.

enumerator PJMEDIA_DIR_RENDER

Same as decoding.

enumerator PJMEDIA_DIR_ENCODING_DECODING

Incoming and outgoing stream, same as PJMEDIA_DIR_CAPTURE_PLAYBACK

enumerator PJMEDIA_DIR_CAPTURE_PLAYBACK

Same as ENCODING_DECODING

enumerator PJMEDIA_DIR_CAPTURE_RENDER

Same as ENCODING_DECODING

enum pjmedia_coord_base

Enumeration for picture coordinate base.

Values:

enumerator PJMEDIA_COORD_BASE_LEFT_TOP

This specifies that the pixel [0, 0] location is at the left-top position.

enumerator PJMEDIA_COORD_BASE_LEFT_BOTTOM

This specifies that the pixel [0, 0] location is at the left-bottom position.

enum pjmedia_orient

Enumeration for video/picture orientation.

Values:

enumerator PJMEDIA_ORIENT_UNKNOWN

Unknown orientation.

enumerator PJMEDIA_ORIENT_NATURAL

Natural orientation, i.e. the original orientation video will be displayed/captured without rotation.

enumerator PJMEDIA_ORIENT_ROTATE_90DEG

Specifies that the video/picture needs to be rotated 90 degrees from its natural orientation in clockwise direction from the user’s perspective. Note that for devices with back cameras (which faces away from the user), the video will actually need to be rotated 270 degrees clockwise instead.

enumerator PJMEDIA_ORIENT_ROTATE_180DEG

Specifies that the video/picture needs to be rotated 180 degrees from its natural orientation.

enumerator PJMEDIA_ORIENT_ROTATE_270DEG

Specifies that the video/picture needs to be rotated 270 degrees from its natural orientation in clockwise direction from the user’s perspective. Note that for devices with back cameras (which faces away from the user), the video will actually need to be rotated 90 degrees clockwise instead.

Functions

const char *pjmedia_type_name(pjmedia_type t)

Utility function to return the string name for a pjmedia_type.

Parameters:

t – The media type.

Returns:

String.

pjmedia_type pjmedia_get_type(const pj_str_t *name)

Utility function to return the media type for a media name string.

Parameters:

name – The media name string.

Returns:

media type.

const char *pjmedia_fourcc_name(pj_uint32_t sig, char buf[])

A utility function to convert fourcc type of value to four letters string.

Parameters:

• sig – The fourcc value.

• buf – Buffer to store the string, which MUST be at least five bytes long.

Returns:

The string.

struct pjmedia_ratio

#include <types.h>

This structure is used to represent rational numbers.

Public Members

int denum

< Numerator.

struct pjmedia_coord

#include <types.h>

This structure represent a coordinate.

Public Members

int x

X position of the coordinate

int y

Y position of the coordinate

struct pjmedia_rect_size

#include <types.h>

This structure represents rectangle size.

Public Members

unsigned w

The width.

unsigned h

The height.

struct pjmedia_rect

#include <types.h>

This structure describes a rectangle.

Public Members

pjmedia_coord coord

The position.

pjmedia_rect_size size

The size.