Package com.amazonaws.ivs.broadcast

Class CodecDiscovery.Result

java.lang.Object

com.amazonaws.ivs.broadcast.CodecDiscovery.Result

Enclosing class:

CodecDiscovery

public static class CodecDiscovery.Result
extends Object

A codec result returned by CodecDiscovery.

Field Summary

Fields

Modifier and Type	Field	Description
BroadcastConfiguration.Video	configuration	The validated BroadcastConfiguration.Video that this codec is known to work with.
BroadcastException	exception	This will be `null` if configuration was provided, otherwise this will provide a description of why the VideoCodec is not available.
String	videoCodecName	The name of the video codec that this result is related to.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

videoCodecName

@NonNull
public String videoCodecName

The name of the video codec that this result is related to. This can be matched with VideoCodecName.

configuration

@Nullable
public BroadcastConfiguration.Video configuration

 The validated BroadcastConfiguration.Video that this codec is known to work with.
 This will be `null` if the codec associated with videoCodecName is not available
 for use on this device for the requested channel or configuration.

 This configuration object will be locked, meaning attempting to change any properties
 (except BroadcastConfiguration.Video.enableTransparency(boolean), BroadcastConfiguration.Video.setUseAutoBitrate(boolean),
 and BroadcastConfiguration.Video.setAutoBitrateProfile(BroadcastConfiguration.AutomaticBitrateProfile))
 will result in throwing a UnsupportedOperationException.
 

exception

@Nullable
public BroadcastException exception

This will be `null` if configuration was provided, otherwise this will provide a description of why the VideoCodec is not available.