Package com.vonage.client.conversations

Class AudioPlayEvent

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.conversations.Event

com.vonage.client.conversations.AudioPlayEvent

All Implemented Interfaces:

Jsonable

public final class AudioPlayEvent
extends Event

Represents an EventType.AUDIO_PLAY event.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AudioPlayEvent.Builder

Method Summary

Modifier and Type	Method	Description
static AudioPlayEvent.Builder	builder()	Entry point for constructing an instance of this class.
Double	getLevel()	Audio volume level, with -1 being quietest, +1 being loudest and 0 the default.
Integer	getLoop()	Number of times to repeat the audio.
UUID	getPlayId()	Unique audio play identifier.
Boolean	getQueue()	Whether to queue the audio.
URI	getStreamUrl()	Source URL of the audio to play.

Methods inherited from class com.vonage.client.conversations.Event

getFrom, getFromMember, getFromUser, getId, getTimestamp, getType

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Method Details

getPlayId

public UUID getPlayId()

Unique audio play identifier.

Returns:

The play ID, or null if unknown.

getStreamUrl

public URI getStreamUrl()

Source URL of the audio to play.

Returns:

The stream URL, or null if unspecified.

builder

public static AudioPlayEvent.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.

getQueue

public Boolean getQueue()

Whether to queue the audio.

Returns:

true if queuing is enabled, or null if unspecified.

getLevel

public Double getLevel()

Audio volume level, with -1 being quietest, +1 being loudest and 0 the default.

Returns:

The volume as a Double, or null if unspecified.

getLoop

public Integer getLoop()

Number of times to repeat the audio.

Returns:

The loop count as an Integer, or null if unspecified.