Group PJSUA2_MED¶

group PJSUA2_MED

Typedefs

typedef std::vector<MediaFormatAudio> MediaFormatAudioVector¶: Array of MediaFormatAudio

typedef std::vector<MediaFormatVideo> MediaFormatVideoVector¶: Array of MediaFormatVideo

typedef void *MediaPort¶: Media port, corresponds to pjmedia_port

typedef std::vector<AudioMedia*> AudioMediaVector¶

Warning: deprecated, use AudioMediaVector2 instead.

Array of Audio Media.

typedef std::vector<AudioMedia> AudioMediaVector2¶: Array of Audio Media

typedef std::vector<ToneDesc> ToneDescVector¶: Array of tone descriptor.

typedef std::vector<ToneDigit> ToneDigitVector¶: Array of tone digits.

typedef std::vector<ToneDigitMapDigit> ToneDigitMapVector¶: Tone digit map

typedef std::vector<AudioDevInfo*> AudioDevInfoVector¶

Warning: deprecated, use AudioDevInfoVector2 instead.

Array of audio device info.

typedef std::vector<AudioDevInfo> AudioDevInfoVector2¶: Array of audio device info

typedef std::vector<VideoMedia> VideoMediaVector¶: Array of Video Media

typedef std::vector<VideoDevInfo*> VideoDevInfoVector¶

Warning: deprecated, use VideoDevInfoVector2 instead.

Array of video device info.

typedef std::vector<VideoDevInfo> VideoDevInfoVector2¶: Array of video device info

typedef std::vector<CodecInfo*> CodecInfoVector¶

Warning: deprecated, use CodecInfoVector2 instead.

Array of codec info.

typedef std::vector<CodecInfo> CodecInfoVector2¶: Array of codec info

typedef std::vector<CodecFmtp> CodecFmtpVector¶: Array of codec fmtp

struct MediaFormat¶

#include <media.hpp>

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

Subclassed by pj::MediaFormatAudio, pj::MediaFormatVideo

struct MediaFormatAudio : public pj::MediaFormat ¶: #include <media.hpp>

This structure describe detail information about an audio media.

struct MediaFormatVideo : public pj::MediaFormat ¶: #include <media.hpp>

This structure describe detail information about an video media.

struct ConfPortInfo¶: #include <media.hpp>

This structure descibes information about a particular media port that has been registered into the conference bridge.

class Media¶

#include <media.hpp>

Media.

Subclassed by pj::AudioMedia, pj::VideoMedia

struct AudioMediaTransmitParam¶: #include <media.hpp>

Parameters for AudioMedia::startTransmit2() method.

class AudioMedia : public pj::Media ¶

#include <media.hpp>

Audio Media. This is a lite wrapper class for audio conference bridge port, i.e: this class only maintains one data member, conference slot ID, and the methods are simply proxies for conference bridge operations.

Application can create a derived class and use registerMediaPort2()/ unregisterMediaPort() to register/unregister a media port to/from the conference bridge.

The library will not keep a list of AudioMedia instances, so any AudioMedia (descendant) instances instantiated by application must be maintained and destroyed by the application itself.

Note that any PJSUA2 APIs that return AudioMedia instance(s) such as Endpoint::mediaEnumPorts2() or Call::getAudioMedia() will just return generated copy. All AudioMedia methods should work normally on this generated copy instance.

Subclassed by pj::AudioMediaPlayer, pj::AudioMediaRecorder, pj::ExtraAudioDevice, pj::ToneGenerator

struct AudioMediaPlayerInfo¶: #include <media.hpp>

This structure contains additional info about AudioMediaPlayer.

class AudioMediaPlayer : public pj::AudioMedia ¶: #include <media.hpp>

Audio Media Player.

class AudioMediaRecorder : public pj::AudioMedia ¶: #include <media.hpp>

Audio Media Recorder.

class ToneDesc : public pjmedia_tone_desc ¶: #include <media.hpp>

Tone descriptor (abstraction for pjmedia_tone_desc)

class ToneDigit : public pjmedia_tone_digit ¶: #include <media.hpp>

Tone digit (abstraction for pjmedia_tone_digit)

struct ToneDigitMapDigit¶: #include <media.hpp>

A digit in tone digit map

class ToneGenerator : public pj::AudioMedia ¶: #include <media.hpp>

Tone generator.

struct AudioDevInfo¶: #include <media.hpp>

Audio device information structure.

class AudDevManager¶: #include <media.hpp>

Audio device manager.

class ExtraAudioDevice : public pj::AudioMedia ¶

#include <media.hpp>

Extra audio device. This class allows application to have multiple sound device instances active concurrently.

Application may also use this class to improve media clock. Normally media clock is driven by sound device in master port, but unfortunately some sound devices may produce jittery clock. To improve media clock, application can install Null Sound Device (i.e: using AudDevManager::setNullDev()), which will act as a master port, and install the sound device as extra sound device.

Note that extra sound device will not have auto-close upon idle feature. Also note that the extra sound device only supports mono channel.

struct MediaCoordinate¶: #include <media.hpp>

Representation of media coordinate.

struct MediaSize¶: #include <media.hpp>

Representation of media size.

struct VidConfPortInfo¶: #include <media.hpp>

This structure descibes information about a particular media port that has been registered into the conference bridge.

struct VideoMediaTransmitParam¶: #include <media.hpp>

Parameters for VideoMedia::startTransmit() method.

class VideoMedia : public pj::Media ¶: #include <media.hpp>

Video Media.

struct WindowHandle¶: #include <media.hpp>

Window handle.

struct VideoWindowHandle¶: #include <media.hpp>

Video window handle.

struct VideoWindowInfo¶: #include <media.hpp>

This structure describes video window info.

class VideoWindow¶: #include <media.hpp>

Video window.

struct VideoPreviewOpParam¶: #include <media.hpp>

This structure contains parameters for VideoPreview::start()

class VideoPreview¶: #include <media.hpp>

Video Preview

struct VideoDevInfo¶: #include <media.hpp>

Video device information structure.

struct VideoSwitchParam¶: #include <media.hpp>

Parameter for switching device with PJMEDIA_VID_DEV_CAP_SWITCH capability.

class VidDevManager¶: #include <media.hpp>

Video device manager.

struct CodecInfo¶: #include <media.hpp>

This structure describes codec information.

struct CodecFmtp¶: #include <media.hpp>

Structure of codec specific parameters which contains name=value pairs. The codec specific parameters are to be used with SDP according to the standards (e.g: RFC 3555) in SDP ‘a=fmtp’ attribute.

struct CodecParamInfo¶: #include <media.hpp>

Audio codec parameters info.

struct CodecParamSetting¶: #include <media.hpp>

Audio codec parameters setting.

struct CodecParam¶

#include <media.hpp>

Detailed codec attributes used in configuring an audio codec and in querying the capability of audio codec factories.

Please note that codec parameter also contains SDP specific setting, #setting::decFmtp and #setting::encFmtp, which may need to be set appropriately based on the effective setting. See each codec documentation for more detail.

struct CodecOpusConfig¶: #include <media.hpp>

Opus codec parameters setting;

struct VidCodecParam¶

#include <media.hpp>

Detailed codec attributes used in configuring a video codec and in querying the capability of video codec factories.

Please note that codec parameter also contains SDP specific setting, decFmtp and encFmtp, which may need to be set appropriately based on the effective setting. See each codec documentation for more detail.

struct MediaFmtChangedEvent¶: #include <media.hpp>

This structure describes a media format changed event.

struct AudDevErrorEvent¶: #include <media.hpp>

This structure describes an audio device error event.

union MediaEventData¶

#include <media.hpp>

Media event data.

Public Members

MediaFmtChangedEvent fmtChanged¶: Media format changed event data.

AudDevErrorEvent audDevError¶: Audio device error event data.

GenericData ptr¶: Pointer to storage to user event data, if it’s outside this struct

struct MediaEvent¶: #include <media.hpp>

This structure describes a media event. It corresponds to the pjmedia_event structure.