LiveEventInner Class

Package:

com.azure.resourcemanager.mediaservices.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-mediaservices:2.3.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.mediaservices.fluent.models.LiveEventInner

public final class LiveEventInner
extends Resource

The live event.

Constructor Summary

Constructor	Description
LiveEventInner()	Creates an instance of LiveEventInner class.

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	created() Get the created property: The creation time for the live event.
CrossSiteAccessPolicies	crossSiteAccessPolicies() Get the crossSiteAccessPolicies property: Live event cross site access policies.
String	description() Get the description property: A description for the live event.
LiveEventEncoding	encoding() Get the encoding property: Encoding settings for the live event.
String	hostnamePrefix() Get 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.
LiveEventInput	input() Get the input property: Live event input settings.
OffsetDateTime	lastModified() Get the lastModified property: The last modified time of the live event.
LiveEventPreview	preview() Get the preview property: Live event preview settings.
String	provisioningState() Get the provisioningState property: The provisioning state of the live event.
LiveEventResourceState	resourceState() Get the resourceState property: The resource state of the live event.
List<StreamOptionsFlag>	streamOptions() Get the streamOptions property: The options to use for the LiveEvent.
SystemData	systemData() Get the systemData property: The system metadata relating to this resource.
List<LiveEventTranscription>	transcriptions() Get the transcriptions property: Live transcription settings for the live event.
Boolean	useStaticHostname() Get the useStaticHostname property: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints.
void	validate() Validates the instance.
LiveEventInner	withCrossSiteAccessPolicies(CrossSiteAccessPolicies crossSiteAccessPolicies) Set the crossSiteAccessPolicies property: Live event cross site access policies.
LiveEventInner	withDescription(String description) Set the description property: A description for the live event.
LiveEventInner	withEncoding(LiveEventEncoding encoding) Set the encoding property: Encoding settings for the live event.
LiveEventInner	withHostnamePrefix(String hostnamePrefix) Set 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.
LiveEventInner	withInput(LiveEventInput input) Set the input property: Live event input settings.
LiveEventInner	withLocation(String location)
LiveEventInner	withPreview(LiveEventPreview preview) Set the preview property: Live event preview settings.
LiveEventInner	withStreamOptions(List<StreamOptionsFlag> streamOptions) Set the streamOptions property: The options to use for the LiveEvent.
LiveEventInner	withTags(Map<String,String> tags)
LiveEventInner	withTranscriptions(List<LiveEventTranscription> transcriptions) Set the transcriptions property: Live transcription settings for the live event.
LiveEventInner	withUseStaticHostname(Boolean useStaticHostname) Set the useStaticHostname property: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

location tags withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LiveEventInner

public LiveEventInner()

Creates an instance of LiveEventInner class.

Method Details

created

public OffsetDateTime created()

Get the created property: The creation time for the live event.

Returns:

the created value.

crossSiteAccessPolicies

public CrossSiteAccessPolicies crossSiteAccessPolicies()

Get the crossSiteAccessPolicies property: Live event cross site access policies.

Returns:

the crossSiteAccessPolicies value.

description

public String description()

Get the description property: A description for the live event.

Returns:

the description value.

encoding

public LiveEventEncoding encoding()

Get 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.

hostnamePrefix

public String hostnamePrefix()

Get 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.

input

public LiveEventInput input()

Get the input property: Live event input settings. It defines how the live event receives input from a contribution encoder.

Returns:

the input value.

lastModified

public OffsetDateTime lastModified()

Get the lastModified property: The last modified time of the live event.

Returns:

the lastModified value.

preview

public LiveEventPreview preview()

Get 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.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning state of the live event.

Returns:

the provisioningState value.

resourceState

public LiveEventResourceState resourceState()

Get 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.

streamOptions

public List streamOptions()

Get 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.

systemData

public SystemData systemData()

Get the systemData property: The system metadata relating to this resource.

Returns:

the systemData value.

transcriptions

public List transcriptions()

Get 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.

useStaticHostname

public Boolean useStaticHostname()

Get 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.

validate

public void validate()

Validates the instance.

withCrossSiteAccessPolicies

public LiveEventInner withCrossSiteAccessPolicies(CrossSiteAccessPolicies crossSiteAccessPolicies)

Set the crossSiteAccessPolicies property: Live event cross site access policies.

Parameters:

crossSiteAccessPolicies - the crossSiteAccessPolicies value to set.

Returns:

the LiveEventInner object itself.

withDescription

public LiveEventInner withDescription(String description)

Set the description property: A description for the live event.

Parameters:

description - the description value to set.

Returns:

the LiveEventInner object itself.

withEncoding

public LiveEventInner withEncoding(LiveEventEncoding encoding)

Set 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.

Parameters:

encoding - the encoding value to set.

Returns:

the LiveEventInner object itself.

withHostnamePrefix

public LiveEventInner withHostnamePrefix(String hostnamePrefix)

Set 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.

Parameters:

hostnamePrefix - the hostnamePrefix value to set.

Returns:

the LiveEventInner object itself.

withInput

public LiveEventInner withInput(LiveEventInput input)

Set the input property: Live event input settings. It defines how the live event receives input from a contribution encoder.

Parameters:

input - the input value to set.

Returns:

the LiveEventInner object itself.

withLocation

public LiveEventInner withLocation(String location)

Overrides:

LiveEventInner.withLocation(String location)

Parameters:

location

withPreview

public LiveEventInner withPreview(LiveEventPreview preview)

Set the preview property: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output.

Parameters:

preview - the preview value to set.

Returns:

the LiveEventInner object itself.

withStreamOptions

public LiveEventInner withStreamOptions(List streamOptions)

Set 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'.

Parameters:

streamOptions - the streamOptions value to set.

Returns:

the LiveEventInner object itself.

withTags

public LiveEventInner withTags(Map tags)

Overrides:

LiveEventInner.withTags(Map<String,String> tags)

Parameters:

tags

withTranscriptions

public LiveEventInner withTranscriptions(List transcriptions)

Set 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.

Parameters:

transcriptions - the transcriptions value to set.

Returns:

the LiveEventInner object itself.

withUseStaticHostname

public LiveEventInner withUseStaticHostname(Boolean useStaticHostname)

Set 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.

Parameters:

useStaticHostname - the useStaticHostname value to set.

Returns:

the LiveEventInner object itself.