Channel (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ivs.model.Channel

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Channel
extends Object
implements Serializable, Cloneable, StructuredPojo

Object specifying a channel.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Channel()

Constructors
Constructor and Description
`Channel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Channel`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Channel`	`clearTagsEntries()` Removes all the entries added into Tags.
`Channel`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Channel ARN.
`Boolean`	`getAuthorized()` Whether the channel is private (enabled for playback authorization).
`String`	`getIngestEndpoint()` Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
`Boolean`	`getInsecureIngest()` Whether the channel allows insecure RTMP ingest.
`String`	`getLatencyMode()` Channel latency mode.
`String`	`getName()` Channel name.
`String`	`getPlaybackUrl()` Channel playback URL.
`String`	`getRecordingConfigurationArn()` Recording-configuration ARN.
`Map<String,String>`	`getTags()` Tags attached to the resource.
`String`	`getType()` Channel type, which determines the allowable resolution and bitrate.
`int`	`hashCode()`
`Boolean`	`isAuthorized()` Whether the channel is private (enabled for playback authorization).
`Boolean`	`isInsecureIngest()` Whether the channel allows insecure RTMP ingest.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` Channel ARN.
`void`	`setAuthorized(Boolean authorized)` Whether the channel is private (enabled for playback authorization).
`void`	`setIngestEndpoint(String ingestEndpoint)` Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
`void`	`setInsecureIngest(Boolean insecureIngest)` Whether the channel allows insecure RTMP ingest.
`void`	`setLatencyMode(String latencyMode)` Channel latency mode.
`void`	`setName(String name)` Channel name.
`void`	`setPlaybackUrl(String playbackUrl)` Channel playback URL.
`void`	`setRecordingConfigurationArn(String recordingConfigurationArn)` Recording-configuration ARN.
`void`	`setTags(Map<String,String> tags)` Tags attached to the resource.
`void`	`setType(String type)` Channel type, which determines the allowable resolution and bitrate.
`String`	`toString()` Returns a string representation of this object.
`Channel`	`withArn(String arn)` Channel ARN.
`Channel`	`withAuthorized(Boolean authorized)` Whether the channel is private (enabled for playback authorization).
`Channel`	`withIngestEndpoint(String ingestEndpoint)` Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
`Channel`	`withInsecureIngest(Boolean insecureIngest)` Whether the channel allows insecure RTMP ingest.
`Channel`	`withLatencyMode(ChannelLatencyMode latencyMode)` Channel latency mode.
`Channel`	`withLatencyMode(String latencyMode)` Channel latency mode.
`Channel`	`withName(String name)` Channel name.
`Channel`	`withPlaybackUrl(String playbackUrl)` Channel playback URL.
`Channel`	`withRecordingConfigurationArn(String recordingConfigurationArn)` Recording-configuration ARN.
`Channel`	`withTags(Map<String,String> tags)` Tags attached to the resource.
`Channel`	`withType(ChannelType type)` Channel type, which determines the allowable resolution and bitrate.
`Channel`	`withType(String type)` Channel type, which determines the allowable resolution and bitrate.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Channel
```
public Channel()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Channel ARN.
    
    Parameters:
    
    arn - Channel ARN.
  - getArn
```
public String getArn()
```
    Channel ARN.
    
    Returns:
    
    Channel ARN.
  - withArn
```
public Channel withArn(String arn)
```
    Channel ARN.
    
    Parameters:
    
    arn - Channel ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorized
```
public void setAuthorized(Boolean authorized)
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Parameters:
    
    authorized - Whether the channel is private (enabled for playback authorization). Default: false.
  - getAuthorized
```
public Boolean getAuthorized()
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Returns:
    
    Whether the channel is private (enabled for playback authorization). Default: false.
  - withAuthorized
```
public Channel withAuthorized(Boolean authorized)
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Parameters:
    
    authorized - Whether the channel is private (enabled for playback authorization). Default: false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAuthorized
```
public Boolean isAuthorized()
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Returns:
    
    Whether the channel is private (enabled for playback authorization). Default: false.
  - setIngestEndpoint
```
public void setIngestEndpoint(String ingestEndpoint)
```
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Parameters:
    
    ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
  - getIngestEndpoint
```
public String getIngestEndpoint()
```
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Returns:
    
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
  - withIngestEndpoint
```
public Channel withIngestEndpoint(String ingestEndpoint)
```
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Parameters:
    
    ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInsecureIngest
```
public void setInsecureIngest(Boolean insecureIngest)
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Parameters:
    
    insecureIngest - Whether the channel allows insecure RTMP ingest. Default: false.
  - getInsecureIngest
```
public Boolean getInsecureIngest()
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Returns:
    
    Whether the channel allows insecure RTMP ingest. Default: false.
  - withInsecureIngest
```
public Channel withInsecureIngest(Boolean insecureIngest)
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Parameters:
    
    insecureIngest - Whether the channel allows insecure RTMP ingest. Default: false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isInsecureIngest
```
public Boolean isInsecureIngest()
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Returns:
    
    Whether the channel allows insecure RTMP ingest. Default: false.
  - setLatencyMode
```
public void setLatencyMode(String latencyMode)
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Parameters:
    
    latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    See Also:
    
    ChannelLatencyMode
  - getLatencyMode
```
public String getLatencyMode()
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Returns:
    
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    See Also:
    
    ChannelLatencyMode
  - withLatencyMode
```
public Channel withLatencyMode(String latencyMode)
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Parameters:
    
    latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelLatencyMode
  - withLatencyMode
```
public Channel withLatencyMode(ChannelLatencyMode latencyMode)
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Parameters:
    
    latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelLatencyMode
  - setName
```
public void setName(String name)
```
    Channel name.
    
    Parameters:
    
    name - Channel name.
  - getName
```
public String getName()
```
    Channel name.
    
    Returns:
    
    Channel name.
  - withName
```
public Channel withName(String name)
```
    Channel name.
    
    Parameters:
    
    name - Channel name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaybackUrl
```
public void setPlaybackUrl(String playbackUrl)
```
    Channel playback URL.
    
    Parameters:
    
    playbackUrl - Channel playback URL.
  - getPlaybackUrl
```
public String getPlaybackUrl()
```
    Channel playback URL.
    
    Returns:
    
    Channel playback URL.
  - withPlaybackUrl
```
public Channel withPlaybackUrl(String playbackUrl)
```
    Channel playback URL.
    
    Parameters:
    
    playbackUrl - Channel playback URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecordingConfigurationArn
```
public void setRecordingConfigurationArn(String recordingConfigurationArn)
```
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Parameters:
    
    recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
  - getRecordingConfigurationArn
```
public String getRecordingConfigurationArn()
```
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Returns:
    
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
  - withRecordingConfigurationArn
```
public Channel withRecordingConfigurationArn(String recordingConfigurationArn)
```
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Parameters:
    
    recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Returns:
    
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Parameters:
    
    tags - Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
  - withTags
```
public Channel withTags(Map<String,String> tags)
```
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Parameters:
    
    tags - Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Channel addTagsEntry(String key,
                            String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Channel clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
    - STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    - BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    Parameters:
    type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . Valid values:
    
    STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    
    BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    See Also:
    
    ChannelType
  - getType
```
public String getType()
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
    - STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    - BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    Returns:
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
    
    STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    
    BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    See Also:
    
    ChannelType
  - withType
```
public Channel withType(String type)
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
    - STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    - BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    Parameters:
    type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . Valid values:
    
    STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    
    BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - withType
```
public Channel withType(ChannelType type)
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
    - STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    - BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    Parameters:
    type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . Valid values:
    
    STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    
    BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Channel clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.476

Class Channel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Channel

Method Detail

setArn

getArn

withArn

setAuthorized

getAuthorized

withAuthorized

isAuthorized

setIngestEndpoint

getIngestEndpoint

withIngestEndpoint

setInsecureIngest

getInsecureIngest

withInsecureIngest

isInsecureIngest

setLatencyMode

getLatencyMode

withLatencyMode

withLatencyMode

setName

getName

withName

setPlaybackUrl

getPlaybackUrl

withPlaybackUrl

setRecordingConfigurationArn

getRecordingConfigurationArn

withRecordingConfigurationArn

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall