F.2 XML schema for MBMS usage information
24.2813GPPMission Critical Video (MCVideo) signalling controlProtocol specificationRelease 18TS
F.2.1 General
This clause defines XML schema and MIME type for application/vnd.3gpp.mcvideo-mbms-usage-info+xml.
F.2.2 XML schema
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="urn:3gpp:ns:mcvideoMbmsUsage:1.0"
xmlns:mcvidmbms="urn:3gpp:ns:mcvideoMbmsUsage:1.0">
<!– the root element –>
<xs:element name="mcvideo-mbms-usage-info" type="mcvidmbms:mcvideo-mbms-usage-info-Type" id="mbms"/>
<xs:complexType name="mcvideo-mbms-usage-info-Type">
<xs:sequence>
<xs:element name="mbms-listening-status" type="mcvidmbms:mbms-listening-statusType"
minOccurs="0"/>
<xs:element name="mbms-suspension-status" type="mcvidmbms:mbms-suspension-statusType"
minOccurs="0"/>
<xs:element name="announcement" type="mcvidmbms:announcementTypeParams" minOccurs="0"/>
<xs:element name="version" type="xs:integer"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="anyExt" type="mcvidmbms:anyExtType" minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="mbms-listening-statusType">
<xs:sequence>
<xs:element name="mbms-listening-status" type="xs:string"/>
<xs:element name="session-id" type="xs:anyURI" minOccurs="0"/>
<xs:element name="general-purpose" type="xs:boolean" minOccurs="0"/>
<xs:element name="TMGI" type="xs:hexBinary" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="anyExt" type="mcvidmbms:anyExtType" minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="mbms-suspension-statusType">
<xs:sequence>
<xs:element name="mbms-suspension-status" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="number-of-reported-bearers" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="suspended-TMGI" type="xs:hexBinary" minOccurs="0"/>
<xs:element name="other-TMGI" type="xs:hexBinary" minOccurs="0" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="anyExt" type="mcvidmbms:anyExtType" minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="announcementTypeParams">
<xs:sequence>
<xs:element name="TMGI" type="xs:hexBinary" minOccurs="1"/>
<xs:element name="QCI" type="xs:integer" minOccurs="0"/>
<xs:element name="frequency" type="xs:unsignedLong" minOccurs="0"/>
<xs:element name="mbms-service-areas" type="mcvidmbms:mbms-service-areasType" minOccurs="0"/>
<xs:element name="GPMS" type="xs:positiveInteger" minOccurs="0"/>
<xs:element name="report-suspension" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="anyExt" type="mcvidmbms:anyExtType" minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!– anyEXT elements for the announcement element – begin –>
<xs:element name="mcvid-mbms-rohc" type="mcvidmbms:emptyType"/>
<!– empty complex type –>
<xs:complexType name="emptyType"/>
<xs:element name="max-cid" type="mcvidmbms:max-cidType"/>
<xs:simpleType name="max-cidType">
<xs:restriction base="xs:integer">
<xs:minInclusive value="1"/>
<xs:maxInclusive value="16383"/>
</xs:restriction>
</xs:simpleType>
<!– anyEXT elements for the announcement element – end –>
<xs:complexType name="mbms-service-areasType">
<xs:sequence>
<xs:element name="mbms-service-area-id" type="xs:hexBinary"
minOccurs="1" maxOccurs="unbounded"/>
<xs:element name="anyExt" type="mcvidmbms:anyExtType" minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute/>
</xs:complexType>
<xs:complexType name="anyExtType">
<xs:sequence>
<xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<!– anyEXT element for the mcvideo-mbms-usage-info element – begin –>
<xs:element name="mbms-defaultMuSiK-download" type="mcvidmbms:mbms-default-ctrlkey-downloadType"/>
<xs:complexType name="mbms-default-ctrlkey-downloadType">
<xs:sequence>
<xs:element type="xs:anyURI" name="group" minOccurs="0" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="anyExt" type="mcvidmbms:anyExtType" minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:element name="mbms-explicitMuSiK-download" type="mcvidmbms:mbms-explicit-ctrlkey-downloadType"/>
<xs:complexType name="mbms-explicit-ctrlkey-downloadType">
<xs:sequence>
<xs:element type="xs:anyURI" name="group" minOccurs="1" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="anyExt" type="mcvidmbms:anyExtType" minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!– anyEXT element for the mcvideo-mbms-usage-info element – end –>
</xs:schema>
F.2.3 Semantic
This clause describes the elements of the MBMS usage information XML Schema.
<mbms-listening-status>: The <mbms-listening-status> element is used to indicate the MCVideo listening status.
– The value "listening" indicates that the MCVideo client now is receiving RTP media packets and transmission control messages over the MBMS subchannel in the session identified by the <session-id> element or if the <general-purpose> element is set to "true", that the MCVideo client is now listening to the general purpose MBMS subchannel.
– The value "not-listening" indicates that the MCVideo client has stopped listening to the MBMS subchannel in the session identified by the <session-id> element or, if the <general-purpose> element is set to "false", that the MCVideo client no longer listens to the general purpose MBMS subchannel.
Table F.2.3-1 shows the ABNF of the <mbms-listening-status> element.
Table F.2.3-1: ABNF syntax of values of the <mbms-listening-status> element
mbms-listening-status = listening-value / not-listening-value
listening-value = %x6c.69.73.74.65.6e.69.6e.67 ; "listening"
not-listening-value = %x6e.6f.74.2d.6c.69.73.74.65.6e.69.6e.67 ; "not-listening"
<session-id>: contains the value of the URI received in the Contact header field received from the controlling MCVideo function when an on-demand session was established, or from the participating MCVideo function in the Connect message when the session was established over a pre-established session. This element is mandatory if the <general-purpose> element is not present in the application/vnd.3gpp.mcvideo-mbms-usage-info+xml MIME body.
<TMGI>: Contains the TMGI. The <TMGI> element is coded as described in 3GPP TS 24.008 [68] clause 10.5.6.13 excluding the Temporary Mobile Group Identity IEI and Length of Temporary Mobile Group Identity contents (octet 1 and octet 2 in 3GPP TS 24.008 [68] clause 10.5.6.13).
<QCI>: QCI information used by the ProSe UE-Network Relay to determine the ProSe Per-Packet Priority value to be applied for the multicast packets relayed to Remote UE over PC5. QCI values are defined in 3GPP TS 23.203 [69].
<mbms-service-areas>: A list of MBMS service area IDs for the applicable MBMS broadcast area as specified in 3GPP TS 23.003 [47] for Service Area Identifier (SAI), and with the encoding as specified in 3GPP TS 29.061 [70] for the MBMS-Service-Area AVP.
<Frequency>: Identification of frequency in case of multi carrier support. The <Frequency> element is coded as specified in 3GPP TS 29.468 [44].
<SDP-ref>: A URL with a cid url as specified in IETF RFC 5368 [71] referring to a SDP MIME body in the SIP MESSAGE request.
<general-purpose> True indicates that the MCVideo client is listening to the general purpose MBMS subchannel associated to the TMGI(s) in the <TMGI> element(s) but have not yet received a Map Group To bearer message for any session that the MCVideo client is involved in. False indicates that the MCVideo client is not listening to the general purpose MBMS subchannel any longer. Absence of the element requires that the <session-id> element is present in the application/vnd.3gpp.mcvideo-mbms-usage-info+xml.
<GPMS> A positive integer that gives the number of the media line containing the general purpose MBMS subchannel in the application/sdp MIME body attached to the SIP MESSAGE request containing the MBMS announcements.
<version> this element indicates the version of the application/vnd.3gpp.mbms-usage-info MIME body. In this version the <version element> indicates "1".
<report-suspension>: True indicates that the MCVideo client is instructed to notify the MCVideo server when it becomes aware of an intended change in the suspension status of a listened MBMS bearer. False indicates that the MCVideo client is instructed not to notify the MCVideo server if it becomes aware of an intended change in the suspension status of a listened MBMS bearer.
<mbms-suspension-status>: The <mbms-suspension-status> element is used to indicate the MBMS bearers intended suspension status.
– The value "suspending" indicates that the RAN has decided to suspend the referenced MBMS bearer(s) at the beginning of the next MCCH modification period.
– The value "not-suspending" indicates that the RAN has decided to revoke its decision to suspend the referenced MBMS bearer(s) before the beginning of the next MCCH modification period.
Table F.2.3-2 shows the ABNF of the <mbms-suspension-status> element.
Table F.2.3-2: ABNF syntax of values of the <mbms-suspension-status> element
mbms-suspension-status = suspending-value / not-suspending-value
suspending-value = %x73.75.73.70.65.6e.64.69.6e.67 ; "suspending"
not-suspending-value = %x6e.6f.74.2d.73.75.73.70.65.6e.64.69.6e.67 ; "not-suspending"
<number-of-reported-bearers>: the total number of occurrences of the <suspended-TMGI> and <other-TMGI> elements reported as part of the MBMS bearer suspension status.
<suspended-TMGI>: Contains a TMGI that is being reported as about to be suspended or as no longer about to be suspended.
<other-TMGI>: Contains a TMGI that is not being reported as about to be suspended or as no longer about to be suspended, but which shares the same MCH with MBMS bearers reported in the <suspended-TMGI> elements.
<mbms-defaultMuSiK-download> is included in <anyExt> element of the <mcvideo-mbms-usage-info-Type> element and provides information for default MuSiK download.
NOTE 2: When included, the <mbms-defaultMuSiK-download> element is validated by the <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> particle of the <anyExt> element.
<mbms-explicitMuSiK-download> is included in <anyExt> element of the < mcvideo -mbms-usage-info-Type> element and provides information for explicit MuSiK download.
NOTE 3: When included, the <mbms-explicitMuSiK-download> element is validated by the <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> particle of the <anyExt> element.
<group>: Contains the identity, in the form of a URI, of a group for which the MuSiK download is performed.
The recipient of the XML ignores any unknown element and any unknown attribute.
F.2.4 IANA registration template
Your Name:
<MCC name>
Your Email Address:
<MCC email address>
Media Type Name:
Application
Subtype name:
vnd.3gpp.mcvideo-mbms-usage-info+xml
Required parameters:
None
Optional parameters:
"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in section 9.1 of IETF RFC 7303.
Encoding considerations:
binary.
Security considerations:
Same as general security considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. In addition, this media type provides a format for exchanging information in SIP, so the security considerations from IETF RFC 3261 apply.
The information transported in this media type does not include active or executable content.
Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229.
This media type does not include provisions for directives that institute actions on a recipient’s files or other resources.
This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient’s privacy in any way.
This media type does not employ compression.
Interoperability considerations:
Same as general interoperability considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. Any unknown XML elements and any unknown XML attributes are to be ignored by recipient of the MIME body.
Published specification:
3GPP TS 24.281 " Mission Critical Video (MCVideo) signalling control;
Protocol specification" version 15.1.0, available via http://www.3gpp.org/specs/numbering.htm.
Applications which use this media type:
Applications supporting the mission critical video as described in the published specification.
Fragment identifier considerations:
The handling in section 5 of IETF RFC 7303 applies.
Restrictions on usage:
None
Provisional registration? (standards tree only):
N/A
Additional information:
1. Deprecated alias names for this type: none
2. Magic number(s): none
3. File extension(s): none
4. Macintosh File Type Code(s): none
5. Object Identifier(s) or OID(s): none
Intended usage:
Common
Person to contact for further information:
– Name: <MCC name>
– Email: <MCC email address>
– Author/Change controller:
i) Author: 3GPP CT1 Working Group/3GPP_TSG_CT_WG1@LIST.ETSI.ORG
ii) Change controller: <MCC name>/<MCC email address>