LiveEventListResponseSchema

Object

• @odata.nextLink: string (Optional)
  URL if the page length and number of items match.

• supplemental: ListResponseSupplementalSchema (Required)
  Supplemental info

  • count: integer (Required)
    Number of items returned
  • kind: string (Required)
    Type of items in the list
  • operation: string (Required)
    Operation type. Should always say 'list'
  • pagination: PaginationInfoSchema (Required)
    Pagination info
    • end: integer (Required)
      Position of the last item in the list
    • records: integer (Required)
      Total number of items returned in the list
    • start: integer (Required)
      Position of the first item in the list
    • total: integer (Required)
      Total number of items in the project

• subscription: ProjectInfoSchema (Optional)
  Project info

  • id: string (Required)
    Project ID
  • name: string (Required)
    Project name

• value: list of objects LiveEventSchema (Required)
  A list of live events.

  • location: string (Optional)
    Deprecated field.
  • name: string (Optional; 2-32 characters; pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$)
    The name of the resource
  • properties: object LiveEventProperties (Required)
    The properties of the live event.
    • created: string (Optional)
      The time when the live event was created.
    • crossSiteAccessPolicies: object CrossSiteAccessPolicies (Optional)
      The configuration for cross-site access policies.
      • clientAccessPolicy: string or null (Optional)
        The XML content of the client access policy file.
      • crossDomainPolicy: string or null (Optional)
        The XML content of the cross-domain policy file.
    • description: string (Optional; 0-4096 characters)
      An optional description for the live event.
    • encoding: object LiveEventEncoding (Required)
      The encoding configuration for the live event.
      • encodingType: enum (Required)
        Allowed values: None, PassthroughBasic, PassthroughStandard, Premium1080p, Standard
      • keyFrameInterval: string (Optional; defaults to PT2S)
        ISO 8601 time value for the output fragment length.
      • presetName: string (Optional)
        Defaults to Default720p or Default1080p based on encoding type.
      • stretchMode: enum (Optional)
        Allowed values: None, AutoSize, AutoFit
      • hostnamePrefix: string (Optional)
        Applied when useStaticHostname=true.
    • input: object LiveEventInput (Required)
      The configuration for the input of the live event.
      • accessControl: object InputAccessControl (Required)
        Access control for live event input.
      • ip: object IPAccessControl (Required)
        The IP access control for live event inputs.
      • accessToken: string (Required; 10-79 characters)
        An access token for input protocols.
      • endpoints: list of objects LiveEventEndpoint (Optional)
        Input endpoints for the live event.
      • keyFrameIntervalDuration: string (Required)
        ISO 8601 value for input key frame interval duration.
      • streamingProtocol: enum (Optional; defaults to RTMP)
        Input protocol for the live event.
      • timedMetadataEndpoints: list of objects LiveEventTimedMetadataEndpoint (Required)
        Metadata endpoints for the live event.
      • lastModified: string (Optional)
        The last modified time of the live event.
    • preview: object LiveEventPreview (Optional)
      Configuration for the preview of the live event.
      • accessControl: object PreviewAccessControl (Optional)
        Address-based ACLs for access to the preview.
      • endpoints: list of objects LiveEventEndpoint (Optional)
        Endpoints for previewing the live event.
      • previewLocator: string (Optional; format: uuid)
        The ID of the locator for the preview.
      • streamingPolicyName: string (Optional; <=260 characters; defaults to Predefined_ClearStreamingOnly)
        DRM streaming policy name for preview.
      • tags: map from strings to string (Required)
        Tags associated with the live event.