WT3a: Changes to support multi-access media delivery (26.512-CR0087)

openapi: 3.0.0

info:

  title: 5GMS UE Media Stream Handling

  version: 1.1.0

  description: |

    5GMS UE Media Stream Handling syntax

    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

tags:

  - name: 5GMS UE Media Stream Handling

    description: '5G Media Streaming: Media Stream Handling'

externalDocs:

  description: 'TS 26.512 V18.5.0; 5G Media Streaming (5GMS); Protocols'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'

paths: {}

components:

  schemas:

    MediaPlayerConfiguration:

      type: object

      description: Configuration of 5GMS media delivery session by 5GMS-Aware Application at reference point M7 or by the Media Session Handler at reference point M11.

      properties:

        sessionId:

          type: string

          description: A media delivery session identifier for the downlink media streaming session.

        source:

          type: object

          description: Provides the MPD and all contained information.

        consumptionMode:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaOperationMode'

          description: >

            In case of live consumption mode, the target latency is maintained, if specified in the service description.

            In case of vod consumption mode, the latency is set by the application and the latency settings are ignored.

        maxBufferTime:

          type: integer

          description: Maximum buffer time in milliseconds for the service.

        serviceDescriptionId:

          type: string

          description: Selects a service description by selecting an identifier.

        serviceDescriptions:

          type: array

          items: 

            $ref: 'TS26512_CommonData.yaml#/components/schemas/ServiceDescription'  

          description: Service description parameters as defined in annex K of ISO/IEC 23009-1. This allows the application to define additional service descriptions beyond those defined in the MPD.

        mediaSettings:

          type: array

          items: 

            $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MediaType'  

          description: Sets the selected Adaptation Set based on the available Adaptation Sets for each media type.

        metricsConfiguration:

          type: array

          items: 

            type: object  

          description: Zero or more sets of settings for collecting metrics in relation to the downlink media streaming session.

        multiAccessConfiguration:

          type: object

          description: Configuration of multi-access media delivery at reference point M4d. If omitted, multi-access delivery is disabled.

          properties:

            transportProtocols:

              type: array

              minItems: 1

              items:

                $ref: 'TS26512_CommonData.yaml#/components/schemas/MultiAccessTransportProtocolType'

              description: A non-empty array of enumerated values to be used by the Media Player for multi-access media delivery at reference point M4d.

            minPaths:

              type: integer

              description: Minimum number of subflows or paths used by the Media Player for multi-access delivery at reference point M4d.  

            maxPaths:

              type: integer

              description: Maximum number of subflows or paths used by the Media Player for multi-access delivery at reference point M4d.

    MediaPlayerDynamicStatus:

      type: object

      description: Dynamically changing status information that can be obtained from the Media Player via reference point M7d or M11d.

      properties:

        state:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaPlayerState'

          description: Enumerated value from list of media player states.

        averageThroughput:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Float'

          description: Current average throughput computed in the ABR logic in bit/s.

        bufferLength:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Float'

          description: Current length of the buffer for a given media type, in seconds.

        liveLatency:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Float'

          description: Current live stream latency in seconds based on the latency measurement.

        mediaSettings:

          type: array

          items: 

            type: object  

          description: Current media settings for each media type based on the CMAF Header and the MPD information based on the selected Adaptation Set for this media type.

        mediaTime:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Float'

          description: Current media playback time from media playback platform.

        playbackRate:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Float'

          description: The current rate of playback.

        availableServiceDescriptions:

          type: array

          items:

            $ref: 'TS26512_CommonData.yaml#/components/schemas/ServiceDescription'

          description: List of available selectable service descriptions with an id to select from.

        availableMediaOptions:

          type: array

          items:

            type: object

          description: List of available media options that can be selected by the application based on the capability discovery and the subset information.

        serviceOperationPoints:

          type: array

          items:

            $ref: 'TS26512_CommonData.yaml#/components/schemas/ServiceOperationPoint'

          description: Set of Service Operation Points declared in the presentation manifest (e.g. DASH MPD) of the current media presentation.

        operativeServiceOperationPoint:

          type: integer

          description: A zero-based index into the serviceOperationPoints array indicating the Service Operation Point currently operative in the playback session.

        metrics:

          type: array

          description: Data blob of metrics for each configured metrics collecting scheme.

          items:

            type: object

        multiAccessConnectionStatus:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/MultiAccessConnectionStatus'

          description: Status information of multi-access delivery connection instance.

 No newline at end of file