Multi-Media Call Control Data Definitions

29.198-04-43GPPOpen Service Access (OSA) Application Programming Interface (API)Part 4: Call controlRelease 9Subpart 4: Multimedia call control Service Capability Feature (SCF)TS

This clause provides the Multi-Media call control data definitions necessary to support the API specification.

The general format of a data definition specification is described below.

  • Data Type:

This shows the name of the data type.

  • Description:

This describes the data type.

  • Tabular Specification:

This specifies the data types and values of the data type.

  • Example:

If relevant, an example is shown to illustrate the data type.

All data types referenced in the present document but not defined in this clause are defined either in the common call control data definitions in 3GPP TS 29.198-4-1 or in the common data definitions which may be found in 3GPP TS 29.198-2.

Event Notification Data Definitions

TpMediaStreamRequestSet

Defines a Numbered Set of Data Elements of TpMediaStreamRequest

TpMediaStreamRequest

Defines the Sequence of Data Elements that specify the type of media stream.

Sequence Element Name

Sequence Element Type

Direction

TpMediaStreamDirection

DataTypeRequest

TpMediaStreamDataTypeRequest

MediaMonitorMode

TpCallMonitorMode

EventType

TpMediaStreamEventType

TpMediaStreamDirection

Defines the direction in which the media stream is established (as seen from the leg).

Name

Value

Description

P_SEND_ONLY

0

Indicates that the offerer is only willing to send this media stream

P_RECEIVE_ONLY

1

Indicates that the offerer is only willing to receive this media stream

P_SEND_RECEIVE

2

Indicates that the offerer is willing to send and receive this media stream

TpMediaStreamDataTypeRequest

Defines the Tagged Choice of Data Elements that specify the media type and associated codecs that are of interest.

Tag Element Type

TpMediaStreamDataTypeRequestType

Tag Element Value

Choice Element Type

Choice Element Name

P_AUDIO_CAPABILITIES

TpAudioCapabilitiesType

Audio

P_VIDEO_CAPABILITIES

TpVideoCapabilitiesType

Video

P_DATA_CAPABILITIES

TpDataCapabilities

Data

TpMediaStreamDataTypeRequestType

Defines the media type of a media stream data type request.

Name

Value

Description

P_AUDIO_CAPABILITIES

1

Audio stream capabilities

P_VIDEO_CAPABILITIES

2

Video stream capabilities

P_DATA_CAPABILITIES

3

Data stream (e.g., ITU-T Rec. T.120) capabilities

TpAudioCapabilitiesType

Defines the audio codec. The requested capabilities can be indicated by adding the values together (i.e., a logical OR function). e.g., 28 indicates interest in all G.722 codes (4+8+16).

Name

Value

Description

P_G711_64K

1

ITU-T Rec. G.711 on 64k, both A-Law and µ-Law

P_G711_56K

2

ITU-T Rec. G.711 on 56k, both A-Law and µ-Law

P_G722_64K

4

ITU-T Rec. G.722 at 64kbit/s

P_G722_56K

8

ITU-T Rec. G.722 at 56kbit/s

P_G722_48K

16

ITU-T Rec. G.722 at 48kbit/s

P_G7231

32

ITU-T Rec. G.723.1

P_G728

64

ITU-T Rec. G.728

P_G729

128

ITU-T Rec. G.729

P_G729_ANNEX_A

256

ITU-T Rec. G.729 Annex A

P_IS11172_3

512

ISO/IEC 11172-3 (MPEG-1 audio)

P_IS13818_3

1024

ISO/IEC 13818-3 (MPEG-2 audio)

P_G729_ANNEXB

2048

ITU-T Rec. G.729 Annex B

P_G729_ANNEX_A_AND_B

4096

ITU-T Rec. G.729 Annex A and B

P_G7231_ANNEX_C

8192

ITU-T Rec. G.723.1 Annex C

P_GSM_FULLRATE

16384

GSM Full Rate Codec

P_GSM_HALFRATE

32768

GSM Half Rate Codec

P_GSM_ENHANCED

65536

GSM Enhanced Full Rate Codec

P_UMTS_AMR_NB

131072

UMTS Narrowband Adaptive Multirate Codec

P_UMTS_AMR_WB

262144

UMTS Wideband Adaptive Multirate Codec

TpVideoCapabilitiesType

Defines the video codec. The requested capabilities can be indicated by adding the values together (i.e., a logical OR function). e.g., 3 indicates both H.261 and H.262 codecs.

Name

Value

Description

P_H261

1

ITU-T Rec. H.261

P_H262

2

ITU-T Rec. H.262

P_H263

4

ITU-T Rec. H.263

P_IS11172_2

8

ISO/IEC 11172-2 (MPEG-1 video)

P_IS14496_2

16

ISO/IEC 14496-2 (MPEG-4 video)

TpDataCapabilities

A TpInt32 defining the minimum maxBitRate in bit/s. I.e., all data media streams whose maxBitRate exceeds this number are reported.

TpMediaStreamEventType

Defines the action performed on the media stream.

Name

Value

Description

P_MEDIA_STREAM_ADDED

0

The media stream is added.

P_MEDIA_STREAM_SUBTRACTED

1

The media stream is subtracted.

P_MEDIA_STREAM_QOS_CLASS_CHANGED

2

A change in QoS class has taken place during the life of the media stream.

TpMediaStreamSet

Defines a Numbered Set of Data Elements of TpMediaStream

TpMediaStream

Defines the Sequence of Data Elements that specify the type of media stream.

Sequence Element Name

Sequence Element Type

Direction

TpMediaStreamDirection

DataType

TpMediaStreamDataType

ChannelSessionID

TpSessionID

MediaStream

IpMultiMediaStream

TpMediaStreamDataType

Defines the type of the reported media stream. It is identical to TpMediaStreamDataTypeRequest, only now the values are not used as a mask, but as the actual codec should be indicated for audio and video. For data the actual maximum bit rate is indicated.

Multi-Media Call Control Data Definitions

IpMultiMediaCall

Defines the address of an IpMultiMediaCall Interface.

IpMultiMediaCallRef

Defines a Reference to type IpMultiMediaCall.

IpAppMultiMediaCall

Defines the address of an IpAppMultiMediaCall Interface.

IpAppMultiMediaCallRef

Defines a Reference to type IpAppMultiMediaCall.

IpMultiMediaCallLeg

Defines the address of an IpMultiMediaCallLeg Interface.

IpMultiMediaCallLegRef

Defines a Reference to type IpMultiMediaCallLeg.

IpAppMultiMediaCallLeg

Defines the address of an IpAppMultiMediaCallLeg Interface.

IpAppMultiMediaCallLegRef

Defines a Reference to type IpAppMultiMediaCallLeg.

TpAppMultiMediaCallLegRefSet

Defines a Numbered Set of Data Elements of IpAppMultiMediaCallLegRef

TpMultiMediaCallIdentifier

Defines the Sequence of Data Elements that unambiguously specify the MultiMediaCall object

Sequence Element Name

Sequence Element Type

Sequence Element Description

MMCallReference

IpMultiMediaCallRef

This element specifies the interface reference for the call object.

MMCallSessionID

TpSessionID

This element specifies the call session ID of the call created.

TpMultiMediaCallIdentifierSet

Defines a Numbered Set of Data Elements of TpMultiMediaCallIdentifier

TpMultiMediaCallLegIdentifier

Defines the Sequence of Data Elements that unambiguously specify the Call Leg object

Sequence Element Name

Sequence Element Type

Sequence Element Description

MMCallLegReference

IpMultiMediaCallLegRef

This element specifies the interface reference for the callLeg object.

MMCallLegSessionID

TpSessionID

This element specifies the callLeg session ID of the call created.

TpMultiMediaCallLegIdentifierSet

Defines a Numbered Set of Data Elements of TpMultiMediaCallLegIdentifier.

IpAppMultiMediaCallControlManager

Defines the address of an IpAppMultiMediaCallControlManager Interface.

IpAppMultiMediaCallControlManagerRef

Defines a Reference to type IpAppMultiMediaCallControlManager.

TpAppMultiMediaCallBack

Defines the Tagged Choice of Data Elements that references the application callback interfaces

Tag Element Type

TpAppMultiMediaCallBackRefType

Tag Element Value

Choice Element Type

Choice Element Name

P_APP_CALLBACK_UNDEFINED

NULL

Undefined

P_APP_MULTIMEDIA_CALL_CALLBACK

IpAppMultiMediaCallRef

AppMultiMediaCall

P_APP_CALL_LEG_CALLBACK

IpAppMultiMediaCallLegRef

AppMultiMediaCallLeg

P_APP_CALL_AND_CALL_LEG_CALLBACK

TpAppMultiMediaCallLegCallBack

AppMultiMediaCallAndCallLeg

TpAppMultiMediaCallBackRefType

Defines the type application call back interface.

Name

Value

Description

P_APP_CALLBACK_UNDEFINED

0

Application Call back interface undefined

P_APP_MULTIMEDIA_CALL_CALLBACK

1

Application Multi-Media Call interface referenced

P_APP_CALL_LEG_CALLBACK

2

Application Multi-Media CallLeg interface referenced

P_APP_CALL_AND_CALL_LEG_CALLBACK

3

Application Multi-Media Call and CallLeg interface referenced

TpAppMultiMediaCallLegCallBack

Defines the Sequence of Data Elements that references a call and a call leg application interface.

Sequence Element Name

Sequence Element Type

AppMultiMediaCall

IpAppMultiMediaCallRef

AppCallLegSet

TpAppMultiMediaCallLegRefSet

Specifies the set of all call leg call back references. First in the set is the reference to the call back of the originating callLeg. In case there is a call back to a destination call leg this will be second in the set.

TpCallSuperviseVolume

Defines the Sequence of Data Elements that specify the amount of volume that is allowed to be transmitted for the specific connection.

Sequence Element Name

Sequence Element Type

Sequence Element Description

VolumeQuantity

TpInt32

This data type is identical to a TpInt32, and defines the quantity of the granted volume that can be transmitted for the specific connection.

VolumeUnit

TpInt32

This data type is identical to a TpInt32, and defines the unit of the granted volume that can be transmitted for the specific connection.

Unit must be specified as 10^n number of bytes, where

n denotes the power.

When the unit is for example in kilobytes, VolumeUnit must be set to 3.

TpNotificationMediaRequest

Defines the Sequence of Data Elements that specify the criteria for a media stream notification.

Sequence Element Name

Sequence Element Type

Description

MediaNotificationScope

TpCallNotificationScope

Defines the scope of the notification request.

MediaStreamsRequested

TpMediaStreamRequestSet

Defines the media stream events which are requested.

TpMediaNotificationRequested

Defines the Sequence of Data Elements that specify the criteria relating to event requests.

Sequence Element Name

Sequence Element Type

AppNotificationMediaRequest

TpNotificationMediaRequest

AssignmentID

TpInt32

TpMediaNotificationsRequestedSet

Defines a numbered Set of Data Elements of TpMediaNotificationRequested

Annex A (normative):
OMG IDL Description of Multi-Media Call Control SCF

The OMG IDL representation of this interface specification is contained in the text file mmccs.idl (contained in archive 2919804-4V800IDL.ZIP) which accompany the present document.

Annex B (informative):
W3C WSDL Description of Multi-Media Call Control SCF

The W3C WSDL representation of this interface specification is contained in zip file 2919804-4V800WSDL.ZIP, which accompanies the present document.

Annex C (informative):
Java API Description of the Call Control SCFs

The Java API realisation of this interface specification is produced in accordance with the Java Realisation rules defined in Part 1 of this specification. These rules aim to deliver for Java, a developer API, provided as a realisation, supporting a Java API that represents the UML specifications. The rules support the production of both J2SE and J2EE versions of the API from the common UML specifications.

The J2SE representation of this interface specification is provided as Java Code, contained in archive 2919804-4V800J2SE.ZIP that accompanies the present document.

The J2EE representation of this interface specification is provided as Java Code, contained in archive 2919804-4V800J2EE.ZIP that accompanies the present document.

Annex D (informative):
Description of Call Control Sub-part 4: Multimedia call control SCF for 3GPP2 cdma2000 networks

This annex is intended to define the OSA API Stage 3 interface definitions and it provides the complete OSA specifications. It is an extension of OSA API specifications capabilities to enable operation in cdma2000 systems environment. They are in alignment with 3GPP2 Stage 1 requirements and Stage 2 architecture defined in:

[1] 3GPP2 P.S0001-B: "Wireless IP Network Standard", Version 1.0, September 2000.

[2] 3GPP2 S.R0037-0: "IP Network Architecture Model for cdma2000 Spread Spectrum Systems", Version 2.0, May 14, 2002.

[3] 3GPP2 X.S0013: "All-IP Core Network Multimedia Domain", December 2003.

These requirements are expressed as additions to and/or exclusions from the 3GPP specification.
The information given here is to be used by developers in 3GPP2 cdma2000 network architecture to interpret the 3GPP OSA specifications.