Package com.azure.resourcemanager.mediaservices.models

Interface LiveEvent

public interface LiveEvent
An immutable client-side representation of LiveEvent.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: The system metadata relating to this resource.
      Returns:
      the systemData value.

    • description

      String description()
      Gets the description property: A description for the live event.
      Returns:
      the description value.

    • input

      LiveEventInput input()
      Gets the input property: Live event input settings. It defines how the live event receives input from a contribution encoder.
      Returns:
      the input value.

    • preview

      LiveEventPreview preview()
      Gets the preview property: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output.
      Returns:
      the preview value.

    • encoding

      LiveEventEncoding encoding()
      Gets the encoding property: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used.
      Returns:
      the encoding value.

    • transcriptions

      List<LiveEventTranscription> transcriptions()
      Gets the transcriptions property: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature.
      Returns:
      the transcriptions value.

    • provisioningState

      String provisioningState()
      Gets the provisioningState property: The provisioning state of the live event.
      Returns:
      the provisioningState value.

    • resourceState

      LiveEventResourceState resourceState()
      Gets the resourceState property: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information.
      Returns:
      the resourceState value.

    • crossSiteAccessPolicies

      CrossSiteAccessPolicies crossSiteAccessPolicies()
      Gets the crossSiteAccessPolicies property: Live event cross site access policies.
      Returns:
      the crossSiteAccessPolicies value.

    • useStaticHostname

      Boolean useStaticHostname()
      Gets the useStaticHostname property: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state.
      Returns:
      the useStaticHostname value.

    • hostnamePrefix

      String hostnamePrefix()
      Gets the hostnamePrefix property: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center.
      Returns:
      the hostnamePrefix value.

    • streamOptions

      List<StreamOptionsFlag> streamOptions()
      Gets the streamOptions property: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'.
      Returns:
      the streamOptions value.

    • created

      OffsetDateTime created()
      Gets the created property: The creation time for the live event.
      Returns:
      the created value.

    • lastModified

      OffsetDateTime lastModified()
      Gets the lastModified property: The last modified time of the live event.
      Returns:
      the lastModified value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      LiveEventInner innerModel()
      Gets the inner com.azure.resourcemanager.mediaservices.fluent.models.LiveEventInner object.
      Returns:
      the inner object.

    • update

      LiveEvent.Update update()
      Begins update for the LiveEvent resource.
      Returns:
      the stage of resource update.

    • refresh

      LiveEvent refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      LiveEvent refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • allocate

      void allocate()
      Allocate resources for a live event

      A live event is in StandBy state after allocation completes, and is ready to start.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • allocate

      void allocate(com.azure.core.util.Context context)
      Allocate resources for a live event

      A live event is in StandBy state after allocation completes, and is ready to start.

      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start()
      Start Live Event

      A live event in Stopped or StandBy state will be in Running state after the start operation completes.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start(com.azure.core.util.Context context)
      Start Live Event

      A live event in Stopped or StandBy state will be in Running state after the start operation completes.

      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop(LiveEventActionInput parameters)
      Stop Live Event

      Stops a running live event.

      Parameters:
      parameters - LiveEvent stop parameters.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop(LiveEventActionInput parameters, com.azure.core.util.Context context)
      Stop Live Event

      Stops a running live event.

      Parameters:
      parameters - LiveEvent stop parameters.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reset

      void reset()
      Reset Live Event

      Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reset

      void reset(com.azure.core.util.Context context)
      Reset Live Event

      Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected.

      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listGetStatus

      com.azure.core.http.rest.PagedIterable<LiveEventStatus> listGetStatus()
      Get status of one live event

      Gets status telemetry of a live event.

      Returns:
      status telemetry of a live event as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listGetStatus

      com.azure.core.http.rest.PagedIterable<LiveEventStatus> listGetStatus(com.azure.core.util.Context context)
      Get status of one live event

      Gets status telemetry of a live event.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      status telemetry of a live event as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listGetStreamEvents

      com.azure.core.http.rest.PagedIterable<LiveEventStreamEvent> listGetStreamEvents()
      Get stream events of one live event

      Get stream events telemetry of a live event.

      Returns:
      stream events telemetry of a live event as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listGetStreamEvents

      com.azure.core.http.rest.PagedIterable<LiveEventStreamEvent> listGetStreamEvents(com.azure.core.util.Context context)
      Get stream events of one live event

      Get stream events telemetry of a live event.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      stream events telemetry of a live event as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listGetTrackIngestHeartbeats

      com.azure.core.http.rest.PagedIterable<LiveEventTrackEvent> listGetTrackIngestHeartbeats()
      Get track events of one live event

      Get track ingest heartbeat events telemetry of a live event.

      Returns:
      track ingest heartbeat events telemetry of a live event as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listGetTrackIngestHeartbeats

      com.azure.core.http.rest.PagedIterable<LiveEventTrackEvent> listGetTrackIngestHeartbeats(com.azure.core.util.Context context)
      Get track events of one live event

      Get track ingest heartbeat events telemetry of a live event.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      track ingest heartbeat events telemetry of a live event as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.