audiostream

Audiostream library.

Functions

Name Summary
playlist

Create an object that represents a playlist.

Tables

Name Summary
Playlist

A playlist object that can be passed to channel.play, channel.gather, or channel.conference.

Tables : audiostream

Playlist

A playlist object that can be passed to channel.play, channel.gather, or channel.conference.

This is the result of calling audiostream.playlist, and can be passed as-is to channel commands which support streaming playlists. Note that this object is not a valid parameter for every channel command that has an audio file argument.

Fields
Name Type Summary
playlist

string

The name of the playlist

announcement_list

string

The name of the announcement list

Functions : audiostream

playlist(playlist, announcement_list)

Create an object that represents a playlist. This creates a Playlist object that can be passed to methdos such as channel.play, channel.gather, and channel.conference which will continuously play the tracks of the playlist indefinitely. If an announcement list is supplied, the announcement tracks will play over the playlist tracks. The tracks of each list as well as the looping behavior of announcements can be configured via the Audiostream REST API.

Parameters
Name Type Default Summary

playlist

string

The name of the playlist

announcement_list

string

nil

The name of the announcement list – may be omitted

Returns
Type Summary

Playlist

A audiostream Playlist.