|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
MultimediaConference | The multimedia conference interface manages the conference. |
MultimediaConference_RI | |
MultimediaConferenceHome | |
MultimediaConferenceService |
Class Summary | |
---|---|
ConferenceInfo | The conference information describes the status of the conference. |
ConferenceInfo_Deser | |
ConferenceInfo_Helper | |
ConferenceInfo_Ser | |
ConferenceStatus | The conference status describes the state of the conference. |
Media | The media describes the type of media that is used. |
MediaDirection | The media direction describes the direction of media flow. |
MultimediaConferenceBindingStub | |
MultimediaConferenceProxy | |
MultimediaConferenceServiceInformation | |
MultimediaConferenceServiceLocator | |
ParticipantInfo | |
ParticipantInfo_Deser | |
ParticipantInfo_Helper | |
ParticipantInfo_Ser | |
ParticipantStatus | The participant status describes the current status of the participant. |
Multimedia Conferencing.
The present document is part 12 of the Stage 3 Parlay X 2 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, for example, the OSA APIs.
The present document specifies the Multimedia Conference Web Service. The following are defined here:
* Name spaces.
* Sequence diagrams.
* Data definitions.
* Interface specification plus detailed method descriptions.
* Fault definitions.
* Service Policies.
* WSDL Description of the interfaces.
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
* References are either specific (identified by date of publication and/or edition number or version number) or nonspecific.
* For a specific reference, subsequent revisions do not apply.
* For a non-specific reference, the latest version applies.
Referenced documents which are not found to be publicly available in the expected location might be found at http://docbox.etsi.org/Reference.
[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X 2 Web Services; Part 1: Common".
For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.
For the purposes of the present document, the abbreviations defined in ES 202 391-1 [2] apply.
The Multimedia Conferencing is a simple Web Service that allows the creation of a multimedia conference and the dynamic management of the participants and the media involved.
The underlying model of the service is based on the following entities:
* Conference: a "context" (uniquely identified) to which participants can be added/removed.
* Participant: each of the parties involved in the conference. Media can be added/removed for each participant. There may exist a participant that is also the "owner" of the conference, for example, the user who can end the call and/or be the reference user for billing purposes.
* Media: the conference can utilize multiple media streams to support the participants' communication. In particular both audio and video streams are available, including the specific stream direction (for example, in, out, bidirectional).
An application setting up a multimedia conference must initially invoke the createConference operation. The result of such invocation is the creation of a "context" that represents a "virtual" room where users can "meet". A unique identifier is assigned to the just-created conference. At this stage no participant is connected.
Subsequently the application may wish to add participants to the conference. In order to do so the operation inviteParticipant can be used. The result of such an operation is to alert the user of the incoming connection request (e.g. the user's terminal rings).
If the application wishes to check whether the user has accepted the invitation (for example, is connected) it can invoke (at a later time) the getParticipantInfo operation.
Note that:
* As soon as the first participant connects, the conference becomes "active". The duration of the conference is then measured starting from the moment the conference has became active.
* The initial media set utilized by the participant will depend on the conference type and the media actually supported by the participant's terminal.
During the conference session the application is able to:
* Add (or remove) a specific media stream to a single participant: for example, adding a video bidirectional stream to a participant that has an audio connection to the conference. This can be obtained by invoking the addMediaForParticipant and the deleteMediaForParticipant operations.
* Disconnect a participant from the conference, by invoking the disconnectParticipant operation.
* Retrieve information related to the conference and its status, by invoking getConferenceInfo and getParticipants.
There are different conditions that can determine the end of the conference:
1) The application may invoke the method endConference, that "forces" the termination of the conference and the disconnection of all participants.
2) The owner of the conference (if defined) leaves the conference. If the owner is not defined this condition will apply when all the participants have left the conference (disconnected).
3) The conference duration exceeds a maximum value (specified during the conference creation step).
The Multimedia Conference interface uses the namespace: http://www.csapi.org/wsdl/parlayx/multimedia_conference/v2_1
The data types are defined in the namespace: http://www.csapi.org/schema/parlayx/multimedia_conference/v2_1
The 'xsd' namespace is used in the present document to refer to the XML Schema data types defined in XML Schema [1]. The use of the name 'xsd' is not semantically significant.
The following sequence diagrams illustrate typical scenarios of interaction between an application and the Multimedia Conferencing Web Service.
Set up a multimedia conference call.
On an existing conference call, add media to, or remove media from, a participant.
During a conference call, the conference owner disconnects.
End of conference call processing when all participants disconnect.
End of conference call processing when the conference is ended by the application.
Initial
The conference has been created but no participant is connected yet
Active
The conference is active, for example, at least one user has connected
Terminated
The conference was terminated
status
ConferenceStatus
Status of the conference
startTime
xsd:dateTime
The time at which the conference was created
duration
xsd:int
The duration of the conference so far (in seconds)
owner
xsd:anyURI
Conference owner
numberOfParticipants
xsd:int
Current number of connected participants
maximumNumberOfParticipants
xsd:int
Maximum number of participants
conferenceIdentifier
xsd:string
Conference identifier
conferenceDescription
xsd:string
Conference description
Participant
xsd:anyURI
Participant identifier
CodecVideoIn
xsd:string
Codec Video IN
CodecVideoOut
xsd:string
Codec Video OUT
CodecAudioIn
xsd:string
Codec Audio IN
CodecAudioOut
xsd:string
Codec Audio OUT
StartTime
xsd:dateTime
Time this participant joined the conference
Status
ParticipantStatus
Status of participant
Invited
Participant invited but not connected yet
Connected
Participant connected
Disconnected
Participant disconnected
Audio
Audio media type
Video
Video media type
Chat
Chat media type
Data
Other media type
In
Incoming
Out
Outgoing
InOut
Bidirectional
Too many participants.
messageId
POL0240
text
Too many participants
variables
None
messageId
POL0241
text
Unavailable media
variables
None
messageId
POL0242
text
Maximum duration exceeded. Maximum allowed is %1 seconds
variables
%1 - maximum duration set by service policy
Service policies for this service.
MaximumDuration
xsd:int
Maximum duration (in seconds) a conference may be set up for
MaximumParticipants
xsd:int
Maximum number of participants a conference may be set up for
ChargingSupported
xsd:boolean
Is charging supported for the createConference operation
Too many participants.
messageId
POL0240
text
Too many participants
variables
None
messageId
POL0241
text
Unavailable media
variables
None
messageId
POL0242
text
Maximum duration exceeded. Maximum allowed is %1 seconds
variables
%1 - maximum duration set by service policy
Service policies for this service.
MaximumDuration
xsd:int
Maximum duration (in seconds) a conference may be set up for
MaximumParticipants
xsd:int
Maximum number of participants a conference may be set up for
ChargingSupported
xsd:boolean
Is charging supported for the createConference operation
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |