sipXcallLib home page
Main Page
Related Pages
Classes
Files
File List
File Members
include
ptapi
PtMediaCapabilities.h
Go to the documentation of this file.
1
//
2
// Copyright (C) 2004-2006 SIPfoundry Inc.
3
// Licensed by SIPfoundry under the LGPL license.
4
//
5
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
6
// Licensed to SIPfoundry under a Contributor Agreement.
7
//
8
// $$
10
11
#ifndef _PtMediaCapabilities_h_
12
#define _PtMediaCapabilities_h_
13
14
// SYSTEM INCLUDES
15
16
// APPLICATION INCLUDES
17
#include <
ptapi/PtDefs.h
>
18
// DEFINES
19
#define CODEC_DELTA 10
20
// MACROS
21
// EXTERNAL FUNCTIONS
22
// EXTERNAL VARIABLES
23
// CONSTANTS
24
// STRUCTS
25
// TYPEDEFS
26
// FORWARD DECLARATIONS
27
class
PtAudioCodec
;
28
29
//:Class short description which may consist of multiple lines (note the ':')
30
// Class detailed description which may extend to multiple lines
31
class
PtMediaCapabilities
32
{
33
/* //////////////////////////// PUBLIC //////////////////////////////////// */
34
public
:
35
36
/* ============================ CREATORS ================================== */
37
38
PtMediaCapabilities
(
PtAudioCodec
aAudioCodecs[] = NULL,
int
numAudioCodecs = 0);
39
//:Default constructor
40
// This constructor takes an optional array of audio codecs which define
41
// the audio capabilities. Note: the order implies the preference (i.e.
42
// the first is prefered over the second, etc.).
45
46
PtMediaCapabilities
(
const
PtMediaCapabilities
& rPtMediaCapabilities);
47
//:Copy constructor
48
49
virtual
50
~PtMediaCapabilities
();
51
//:Destructor
52
53
/* ============================ MANIPULATORS ============================== */
54
55
PtMediaCapabilities
&
operator=
(
const
PtMediaCapabilities
& rhs);
56
//:Assignment operator
57
58
/* ============================ ACCESSORS ================================= */
59
60
int
getNumAudioCodecs
()
const
;
61
//: Get the number of codecs contained in this PtMediaCapabilities object.
63
64
PtBoolean
getAudioCodec
(
int
index,
PtAudioCodec
& codec);
65
//: Get the condec contained at the given index
70
71
void
addAudioCodec
(
PtAudioCodec
& codec);
72
//: Add an audio codec to this PtMediaCapabilities object.
73
// Note: the order in which the codecs are added implies the preference
74
// (i.e. The first is prefered over the second and so on.).
76
77
/* ============================ INQUIRY =================================== */
78
79
/* //////////////////////////// PROTECTED ///////////////////////////////// */
80
protected
:
81
82
/* //////////////////////////// PRIVATE /////////////////////////////////// */
83
private
:
84
int
mSizeAudioCodecs
;
85
int
mNumAudioCodecs
;
86
PtAudioCodec
*
mAudioCodecs
;
87
88
};
89
90
/* ============================ INLINE METHODS ============================ */
91
92
#endif // _PtMediaCapabilities_h_
PtMediaCapabilities::mAudioCodecs
PtAudioCodec * mAudioCodecs
Definition:
PtMediaCapabilities.h:86
PtBoolean
int PtBoolean
Definition:
PtDefs.h:71
PtMediaCapabilities::mSizeAudioCodecs
int mSizeAudioCodecs
param: (in) codec - the codec to be copied and added to this PtMediaCapabilities object.
Definition:
PtMediaCapabilities.h:84
PtDefs.h
PtMediaCapabilities::getNumAudioCodecs
int getNumAudioCodecs() const
Definition:
PtMediaCapabilities.cpp:98
PtMediaCapabilities::~PtMediaCapabilities
virtual ~PtMediaCapabilities()
Definition:
PtMediaCapabilities.cpp:63
PtMediaCapabilities::PtMediaCapabilities
PtMediaCapabilities(PtAudioCodec aAudioCodecs[]=NULL, int numAudioCodecs=0)
Definition:
PtMediaCapabilities.cpp:31
PtMediaCapabilities::addAudioCodec
void addAudioCodec(PtAudioCodec &codec)
param: (in) index - index indicating which codec is requested. param: (out) codec - reference to code...
Definition:
PtMediaCapabilities.cpp:117
PtMediaCapabilities::operator=
PtMediaCapabilities & operator=(const PtMediaCapabilities &rhs)
Definition:
PtMediaCapabilities.cpp:76
PtMediaCapabilities::getAudioCodec
PtBoolean getAudioCodec(int index, PtAudioCodec &codec)
returns: the number of codecs
Definition:
PtMediaCapabilities.cpp:105
PtAudioCodec
Definition:
PtAudioCodec.h:40
PtMediaCapabilities::mNumAudioCodecs
int mNumAudioCodecs
Definition:
PtMediaCapabilities.h:85
PtMediaCapabilities
Definition:
PtMediaCapabilities.h:31