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.
`String`	`getLatencyMode()` Channel latency mode.
`String`	`getName()` Channel name.
`String`	`getPlaybackUrl()` Channel playback URL.
`String`	`getRecordingConfigurationArn()` Recording-configuration ARN.
`Map<String,String>`	`getTags()` Array of 1-50 maps, each of the form `string:string (key:value)`.
`String`	`getType()` Channel type, which determines the allowable resolution and bitrate.
`int`	`hashCode()`
`Boolean`	`isAuthorized()` Whether the channel is private (enabled for playback authorization).
`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`	`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)` Array of 1-50 maps, each of the form `string:string (key:value)`.
`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`	`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)` Array of 1-50 maps, each of the form `string:string (key:value)`.
`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.
  - 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.
  - 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
  - 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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    - BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    
    BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    - BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    
    BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    - BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    
    BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    - BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
    
    BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - 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.
  - 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.
  - 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.
  - 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.
  - getTags
```
public Map<String,String> getTags()
```
    Array of 1-50 maps, each of the form string:string (key:value).
    
    Returns:
    
    Array of 1-50 maps, each of the form string:string (key:value).
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Array of 1-50 maps, each of the form string:string (key:value).
    
    Parameters:
    
    tags - Array of 1-50 maps, each of the form string:string (key:value).
  - withTags
```
public Channel withTags(Map<String,String> tags)
```
    Array of 1-50 maps, each of the form string:string (key:value).
    
    Parameters:
    
    tags - Array of 1-50 maps, each of the form string:string (key:value).
    
    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.
  - 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.

Did this page help you?

Class Channel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Channel

Method Detail

setArn

getArn

withArn

setName

getName

withName

setLatencyMode

getLatencyMode

withLatencyMode

withLatencyMode

setType

getType

withType

withType

setRecordingConfigurationArn

getRecordingConfigurationArn

withRecordingConfigurationArn

setIngestEndpoint

getIngestEndpoint

withIngestEndpoint

setPlaybackUrl

getPlaybackUrl

withPlaybackUrl

setAuthorized

getAuthorized

withAuthorized

isAuthorized

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall