Class StreamAction

Namespace

Vonage.Voice.Nccos

Assembly

Vonage.dll

Represents an NCCO Stream action that plays an audio file from a URL into the call.

public class StreamAction : NccoAction

Inheritance

object

NccoAction

StreamAction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Action

The type of NCCO action to execute.

[JsonProperty("action", Order = 0)]
public override NccoAction.ActionType Action { get; }

Property Value

NccoAction.ActionType

BargeIn

Set to true so this action is terminated when the user presses a button on the keypad. Use this feature to enable users to choose an option without having to listen to the whole message in your Interactive Voice Response (IVR ). If you set bargeIn to true on one more Stream actions then the next non-stream action in the NCCO stack must be an input action. The default value is false. Once bargeIn is set to true it will stay true (even if bargeIn: false is set in a following action) until an input action is encountered

[JsonProperty("bargeIn", Order = 3)]
public bool BargeIn { get; set; }

Property Value

bool

Level

Set the audio level of the stream in the range -1 >=level<=1 with a precision of 0.1. The default value is 0.

[JsonProperty("level", Order = 2)]
public string Level { get; set; }

Property Value

string

Loop

The number of times audio is repeated before the Call is closed. The default value is 1. Set to 0 to loop infinitely.

[JsonProperty("loop", Order = 4)]
public string Loop { get; set; }

Property Value

string

StreamUrl

An array containing a single URL to an mp3 or wav (16-bit) audio file to stream to the Call or Conversation.

[JsonProperty("streamUrl", Order = 1)]
public string[] StreamUrl { get; set; }

Property Value

string[]