swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MediaComposition API
schemes:
- https
tags:
- name: MediaComposition
paths:
  /mediaCompositions/{mediaCompositionId}:
    get:
      tags:
      - MediaComposition
      summary: Microsoft Azure Gets A Media Composition
      operationId: microsoftAzureMediacompositionGet
      produces:
      - application/json
      parameters:
      - in: path
        name: mediaCompositionId
        description: The media composition id
        required: true
        type: string
        maxLength: 256
        pattern: ^[0-9a-zA-Z-]+$
      - in: query
        name: api-version
        description: The API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MediaComposition'
        '400':
          description: Bad Request.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        default:
          description: Failure
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              description: The error code.
              type: string
          x-ms-error-response: true
      x-ms-examples:
        Get Media Composition:
          $ref: ./examples/MediaComposition_GetMediaComposition.json
      description: Needs a more full description created.
    put:
      tags:
      - MediaComposition
      summary: Microsoft Azure Creates A New Media Composition
      operationId: microsoftAzureMediacompositionCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: mediaCompositionId
        description: The media composition id
        required: true
        type: string
        maxLength: 256
        pattern: ^[0-9a-zA-Z-]+$
      - in: query
        name: api-version
        description: The API version
        required: true
        type: string
      - in: body
        name: body
        description: The media composition object to create
        required: true
        schema:
          $ref: '#/definitions/MediaComposition'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MediaComposition'
        '400':
          description: Bad Request.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        default:
          description: Failure
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              description: The error code.
              type: string
          x-ms-error-response: true
      x-ms-examples:
        Create new Media Composition:
          $ref: ./examples/MediaComposition_CreateMediaComposition.json
      description: Needs a more full description created.
    patch:
      tags:
      - MediaComposition
      summary: Microsoft Azure Updates An Existing Media Composition
      operationId: microsoftAzureMediacompositionUpdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: mediaCompositionId
        description: The media composition id
        required: true
        type: string
        maxLength: 256
        pattern: ^[0-9a-zA-Z-]+$
      - in: query
        name: api-version
        description: The API version
        required: true
        type: string
      - in: body
        name: body
        description: The media composition object to update
        required: true
        schema:
          $ref: '#/definitions/MediaComposition'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MediaComposition'
        '400':
          description: Bad Request.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        default:
          description: Failure
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              description: The error code.
              type: string
          x-ms-error-response: true
      x-ms-examples:
        Update Media Composition - Change source:
          $ref: ./examples/MediaComposition_UpdateMediaComposition.json
      description: Needs a more full description created.
    delete:
      tags:
      - MediaComposition
      summary: Microsoft Azure Deletes A Media Composition
      operationId: microsoftAzureMediacompositionDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: mediaCompositionId
        description: The media composition id
        required: true
        type: string
        maxLength: 256
        pattern: ^[0-9a-zA-Z-]+$
      - in: query
        name: api-version
        description: The API version
        required: true
        type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        default:
          description: Failure
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              description: The error code.
              type: string
          x-ms-error-response: true
      x-ms-examples:
        Delete Media Composition:
          $ref: ./examples/MediaComposition_DeleteMediaComposition.json
      description: Needs a more full description created.
  /mediaCompositions/{mediaCompositionId}:start:
    post:
      tags:
      - MediaComposition
      summary: Microsoft Azure Starts The Composition
      operationId: microsoftAzureMediacompositionStart
      produces:
      - application/json
      parameters:
      - in: path
        name: mediaCompositionId
        description: The media composition id
        required: true
        type: string
        maxLength: 256
        pattern: ^[0-9a-zA-Z-]+$
      - in: query
        name: api-version
        description: The API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CompositionStreamState'
        '400':
          description: Bad Request.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        default:
          description: Failure
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              description: The error code.
              type: string
          x-ms-error-response: true
      x-ms-examples:
        Start Media Composition:
          $ref: ./examples/MediaComposition_StartMediaComposition.json
      description: Needs a more full description created.
  /mediaCompositions/{mediaCompositionId}:stop:
    post:
      tags:
      - MediaComposition
      summary: Microsoft Azure Stops The Composition
      operationId: microsoftAzureMediacompositionStop
      produces:
      - application/json
      parameters:
      - in: path
        name: mediaCompositionId
        description: The media composition id
        required: true
        type: string
        maxLength: 256
        pattern: ^[0-9a-zA-Z-]+$
      - in: query
        name: api-version
        description: The API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CompositionStreamState'
        '400':
          description: Bad Request.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        default:
          description: Failure
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              description: The error code.
              type: string
          x-ms-error-response: true
      x-ms-examples:
        Stop Media Composition:
          $ref: ./examples/MediaComposition_StopMediaComposition.json
      description: Needs a more full description created.
definitions:
  StreamStatus:
    description: State of the composition stream
    enum:
    - notStarted
    - running
    - stopped
    type: string
    x-ms-enum:
      name: StreamStatus
      modelAsString: true
  MediaOutputType:
    description: Kind of media output
    enum:
    - groupCall
    - room
    - teamsMeeting
    - srt
    - rtmp
    type: string
    x-ms-enum:
      name: MediaOutputType
      modelAsString: true
  CompositionStreamState:
    description: Provides the state of the media composition
    type: object
    properties:
      status:
        $ref: '#/definitions/StreamStatus'
  CommunicationErrorResponse:
    $ref: ../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse
  Layout:
    description: Configure a layout
    required:
    - kind
    type: object
    properties:
      kind:
        $ref: '#/definitions/LayoutType'
      resolution:
        $ref: '#/definitions/Resolution'
      placeholderImageUri:
        description: Set global placeholder image
        type: string
      scalingMode:
        $ref: '#/definitions/ScalingMode'
    discriminator: kind
  MediaInputType:
    description: Kind of media input
    enum:
    - participant
    - screenShare
    - dominantSpeaker
    - activePresenter
    - image
    - groupCall
    - room
    - teamsMeeting
    - srt
    - rtmp
    type: string
    x-ms-enum:
      name: MediaInputType
      modelAsString: true
  MediaInput:
    description: Media input to be used in the composition
    required:
    - kind
    type: object
    properties:
      kind:
        $ref: '#/definitions/MediaInputType'
      placeholderImageUri:
        description: Image url to be used if participant has no video stream
        type: string
    discriminator: kind
  MediaComposition:
    description: Body of a media composition
    type: object
    properties:
      id:
        description: Id of the media composition
        type: string
      layout:
        $ref: '#/definitions/Layout'
      inputs:
        description: Inputs used in the composition
        type: object
        additionalProperties:
          $ref: '#/definitions/MediaInput'
      outputs:
        description: Outputs used in the composition
        type: object
        additionalProperties:
          $ref: '#/definitions/MediaOutput'
      streamState:
        $ref: '#/definitions/CompositionStreamState'
  MediaOutput:
    description: Media output to be used in the composition
    required:
    - kind
    type: object
    properties:
      kind:
        $ref: '#/definitions/MediaOutputType'
    discriminator: kind
  LayoutType:
    description: Kind of layout
    enum:
    - custom
    - grid
    - autoGrid
    - presentation
    - presenter
    type: string
    x-ms-enum:
      name: LayoutType
      modelAsString: true
  Resolution:
    description: The dimensions of the scene or objects in the scene
    required:
    - height
    - width
    type: object
    properties:
      width:
        format: int32
        description: Width of the object
        type: integer
      height:
        format: int32
        description: Height of the object
        type: integer
  ScalingMode:
    description: The scaling mode for the view of a video stream in a cell.
    enum:
    - stretch
    - crop
    - fit
    type: string
    x-ms-enum:
      name: ScalingMode
      modelAsString: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'