com.amazonaws.services.kinesisvideosignaling.model

Class SendAlexaOfferToMasterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideosignaling.model.SendAlexaOfferToMasterRequest

All Implemented Interfaces:

Serializable, Cloneable

public class SendAlexaOfferToMasterRequest
extends AmazonWebServiceRequest
implements Serializable

This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendAlexaOfferToMasterRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getChannelARN() The ARN of the signaling channel by which Alexa and the master peer communicate.
String	getMessagePayload() The base64-encoded SDP offer content.
String	getSenderClientId() The unique identifier for the sender client.
int	hashCode()
void	setChannelARN(String channelARN) The ARN of the signaling channel by which Alexa and the master peer communicate.
void	setMessagePayload(String messagePayload) The base64-encoded SDP offer content.
void	setSenderClientId(String senderClientId) The unique identifier for the sender client.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SendAlexaOfferToMasterRequest	withChannelARN(String channelARN) The ARN of the signaling channel by which Alexa and the master peer communicate.
SendAlexaOfferToMasterRequest	withMessagePayload(String messagePayload) The base64-encoded SDP offer content.
SendAlexaOfferToMasterRequest	withSenderClientId(String senderClientId) The unique identifier for the sender client.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendAlexaOfferToMasterRequest

public SendAlexaOfferToMasterRequest()

Method Detail

getChannelARN

public String getChannelARN()

The ARN of the signaling channel by which Alexa and the master peer communicate.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Returns:

The ARN of the signaling channel by which Alexa and the master peer communicate.

setChannelARN

public void setChannelARN(String channelARN)

The ARN of the signaling channel by which Alexa and the master peer communicate.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Parameters:

channelARN -

The ARN of the signaling channel by which Alexa and the master peer communicate.

withChannelARN

public SendAlexaOfferToMasterRequest withChannelARN(String channelARN)

The ARN of the signaling channel by which Alexa and the master peer communicate.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Parameters:

channelARN -

The ARN of the signaling channel by which Alexa and the master peer communicate.

Returns:

A reference to this updated object so that method calls can be chained together.

getSenderClientId

public String getSenderClientId()

The unique identifier for the sender client.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Returns:

The unique identifier for the sender client.

setSenderClientId

public void setSenderClientId(String senderClientId)

The unique identifier for the sender client.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

senderClientId -

The unique identifier for the sender client.

withSenderClientId

public SendAlexaOfferToMasterRequest withSenderClientId(String senderClientId)

The unique identifier for the sender client.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

senderClientId -

The unique identifier for the sender client.

Returns:

A reference to this updated object so that method calls can be chained together.

getMessagePayload

public String getMessagePayload()

The base64-encoded SDP offer content.

Constraints:
Length: 1 - 10000
Pattern: [a-zA-Z0-9+/=]+

Returns:

The base64-encoded SDP offer content.

setMessagePayload

public void setMessagePayload(String messagePayload)

The base64-encoded SDP offer content.

Constraints:
Length: 1 - 10000
Pattern: [a-zA-Z0-9+/=]+

Parameters:

messagePayload -

The base64-encoded SDP offer content.

withMessagePayload

public SendAlexaOfferToMasterRequest withMessagePayload(String messagePayload)

The base64-encoded SDP offer content.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 10000
Pattern: [a-zA-Z0-9+/=]+

Parameters:

messagePayload -

The base64-encoded SDP offer content.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object