LiveEvent Interface
public interface LiveEvent
An immutable client-side representation of LiveEvent.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| abstract void |
allocate()
Allocate resources for a live event |
| abstract void |
allocate(Context context)
Allocate resources for a live event |
|
abstract
Offset |
created()
Gets the created property: The creation time for the live event. |
|
abstract
Cross |
crossSiteAccessPolicies()
Gets the cross |
| abstract String |
description()
Gets the description property: A description for the live event. |
|
abstract
Live |
encoding()
Gets the encoding property: Encoding settings for the live event. |
| abstract String |
hostnamePrefix()
Gets the hostname |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Live |
innerModel()
Gets the inner com. |
|
abstract
Live |
input()
Gets the input property: Live event input settings. |
|
abstract
Offset |
lastModified()
Gets the last |
| abstract String |
location()
Gets the location property: The geo-location where the resource lives. |
| abstract String |
name()
Gets the name property: The name of the resource. |
|
abstract
Live |
preview()
Gets the preview property: Live event preview settings. |
| abstract String |
provisioningState()
Gets the provisioning |
|
abstract
Live |
refresh()
Refreshes the resource to sync with Azure. |
|
abstract
Live |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract Region |
region()
Gets the region of the resource. |
| abstract String |
regionName()
Gets the name of the resource region. |
| abstract void |
reset()
Reset Live Event |
| abstract void |
reset(Context context)
Reset Live Event |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
|
abstract
Live |
resourceState()
Gets the resource |
| abstract void |
start()
Start Live Event |
| abstract void |
start(Context context)
Start Live Event |
| abstract void |
stop(LiveEventActionInput parameters)
Stop Live Event |
| abstract void |
stop(LiveEventActionInput parameters, Context context)
Stop Live Event |
|
abstract
List<Stream |
streamOptions()
Gets the stream |
|
abstract
System |
systemData()
Gets the system |
| abstract Map<String,String> |
tags()
Gets the tags property: Resource tags. |
|
abstract
List<Live |
transcriptions()
Gets the transcriptions property: Live transcription settings for the live event. |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Live |
| abstract Boolean |
useStaticHostname()
Gets the use |
Method Details
allocate
public abstract void allocate()
Allocate resources for a live event
A live event is in StandBy state after allocation completes, and is ready to start.
allocate
public abstract void allocate(Context context)
Allocate resources for a live event
A live event is in StandBy state after allocation completes, and is ready to start.
Parameters:
created
public abstract OffsetDateTime created()
Gets the created property: The creation time for the live event.
Returns:
crossSiteAccessPolicies
public abstract CrossSiteAccessPolicies crossSiteAccessPolicies()
Gets the crossSiteAccessPolicies property: Live event cross site access policies.
Returns:
description
public abstract String description()
Gets the description property: A description for the live event.
Returns:
encoding
public abstract 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:
hostnamePrefix
public abstract 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:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
innerModel
public abstract LiveEventInner innerModel()
Gets the inner com.azure.resourcemanager.mediaservices.fluent.models.LiveEventInner object.
Returns:
input
public abstract LiveEventInput input()
Gets the input property: Live event input settings. It defines how the live event receives input from a contribution encoder.
Returns:
lastModified
public abstract OffsetDateTime lastModified()
Gets the lastModified property: The last modified time of the live event.
Returns:
location
public abstract String location()
Gets the location property: The geo-location where the resource lives.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
preview
public abstract 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:
provisioningState
public abstract String provisioningState()
Gets the provisioningState property: The provisioning state of the live event.
Returns:
refresh
public abstract LiveEvent refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract LiveEvent refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
region
public abstract Region region()
Gets the region of the resource.
Returns:
regionName
public abstract String regionName()
Gets the name of the resource region.
Returns:
reset
public abstract 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.
reset
public abstract void reset(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:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
resourceState
public abstract 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:
start
public abstract void start()
Start Live Event
A live event in Stopped or StandBy state will be in Running state after the start operation completes.
start
public abstract void start(Context context)
Start Live Event
A live event in Stopped or StandBy state will be in Running state after the start operation completes.
Parameters:
stop
public abstract void stop(LiveEventActionInput parameters)
Stop Live Event
Stops a running live event.
Parameters:
stop
public abstract void stop(LiveEventActionInput parameters, Context context)
Stop Live Event
Stops a running live event.
Parameters:
streamOptions
public abstract List
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:
systemData
public abstract SystemData systemData()
Gets the systemData property: The system metadata relating to this resource.
Returns:
tags
public abstract Map
Gets the tags property: Resource tags.
Returns:
transcriptions
public abstract List
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:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract LiveEvent.Update update()
Begins update for the LiveEvent resource.
Returns:
useStaticHostname
public abstract 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:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for