azure.mgmt.media.models.LiveEventPreview.yml

### YamlMime:PythonClass
uid: azure.mgmt.media.models.LiveEventPreview
name: LiveEventPreview
fullName: azure.mgmt.media.models.LiveEventPreview
module: azure.mgmt.media.models
inheritances:
- azure.mgmt.media._serialization.Model
summary: Live event preview settings.
constructor:
  syntax: 'LiveEventPreview(*, endpoints: List[_models.LiveEventEndpoint] | None =
    None, access_control: _models.LiveEventPreviewAccessControl | None = None, preview_locator:
    str | None = None, streaming_policy_name: str | None = None, alternative_media_id:
    str | None = None, **kwargs)'
  keywordOnlyParameters:
  - name: endpoints
    description: 'The endpoints for preview. Do not share the preview URL with the
      live event

      audience.'
    types:
    - <xref:list>[<xref:azure.mgmt.media.models.LiveEventEndpoint>]
  - name: access_control
    description: The access control for live event preview.
    types:
    - <xref:azure.mgmt.media.models.LiveEventPreviewAccessControl>
  - name: preview_locator
    description: 'The identifier of the preview locator in Guid format. Specifying
      this

      at creation time allows the caller to know the preview locator url before the
      event is created.

      If omitted, the service will generate a random identifier. This value cannot
      be updated once

      the live event is created.'
    types:
    - <xref:str>
  - name: streaming_policy_name
    description: 'The name of streaming policy used for the live event preview.

      This value is specified at creation time and cannot be updated.'
    types:
    - <xref:str>
  - name: alternative_media_id
    description: 'An alternative media identifier associated with the streaming

      locator created for the preview. This value is specified at creation time and
      cannot be

      updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate
      or the

      CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName

      field.'
    types:
    - <xref:str>
variables:
- description: 'The endpoints for preview. Do not share the preview URL with the live
    event

    audience.'
  name: endpoints
  types:
  - <xref:list>[<xref:azure.mgmt.media.models.LiveEventEndpoint>]
- description: The access control for live event preview.
  name: access_control
  types:
  - <xref:azure.mgmt.media.models.LiveEventPreviewAccessControl>
- description: 'The identifier of the preview locator in Guid format. Specifying this
    at

    creation time allows the caller to know the preview locator url before the event
    is created. If

    omitted, the service will generate a random identifier. This value cannot be updated
    once the

    live event is created.'
  name: preview_locator
  types:
  - <xref:str>
- description: 'The name of streaming policy used for the live event preview. This

    value is specified at creation time and cannot be updated.'
  name: streaming_policy_name
  types:
  - <xref:str>
- description: 'An alternative media identifier associated with the streaming

    locator created for the preview. This value is specified at creation time and
    cannot be

    updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate
    or the

    CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName

    field.'
  name: alternative_media_id
  types:
  - <xref:str>