Class: Twilio::REST::Media::V1::PlayerStreamerList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/media/v1/player_streamer.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ PlayerStreamerList

Initialize the PlayerStreamerList

Parameters:

  • version (Version) —

    Version that contains the resource


18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/PlayerStreamers"
end

Instance Method Details

#create(video: :unset, status_callback: :unset, status_callback_method: :unset, max_duration: :unset) ⇒ PlayerStreamerInstance

Create the PlayerStreamerInstance

Parameters:

  • video (Boolean) (defaults to: :unset) —

    Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`.

  • status_callback (String) (defaults to: :unset) —

    The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See Status Callbacks for more details.

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.

  • max_duration (String) (defaults to: :unset) —

    The maximum time, in seconds, that the PlayerStreamer can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming.

Returns:


41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 41

def create(video: :unset, status_callback: :unset, status_callback_method: :unset, max_duration: :unset)
  data = Twilio::Values.of({
      'Video' => video,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'MaxDuration' => max_duration,
  })

  payload = @version.create('POST', @uri, data: data)

  PlayerStreamerInstance.new(@version, payload, )
end

#each ⇒ Object

When passed a block, yields PlayerStreamerInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


102
103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 102

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of PlayerStreamerInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of PlayerStreamerInstance


143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 143

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  PlayerStreamerPage.new(@version, response, @solution)
end

#list(order: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

Lists PlayerStreamerInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • order (player_streamer.Order) (defaults to: :unset) —

    The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

  • status (player_streamer.Status) (defaults to: :unset) —

    Status to filter by, with possible values `created`, `started`, `ended`, or `failed`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results


70
71
72
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 70

def list(order: :unset, status: :unset, limit: nil, page_size: nil)
  self.stream(order: order, status: status, limit: limit, page_size: page_size).entries
end

#page(order: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of PlayerStreamerInstance records from the API. Request is executed immediately.

Parameters:

  • order (player_streamer.Order) (defaults to: :unset) —

    The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

  • status (player_streamer.Status) (defaults to: :unset) —

    Status to filter by, with possible values `created`, `started`, `ended`, or `failed`.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of PlayerStreamerInstance


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 124

def page(order: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Order' => order,
      'Status' => status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  PlayerStreamerPage.new(@version, response, @solution)
end

#stream(order: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams PlayerStreamerInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • order (player_streamer.Order) (defaults to: :unset) —

    The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

  • status (player_streamer.Status) (defaults to: :unset) —

    Status to filter by, with possible values `created`, `started`, `ended`, or `failed`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results


90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 90

def stream(order: :unset, status: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(order: order, status: status, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation


153
154
155
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 153

def to_s
  '#<Twilio.Media.V1.PlayerStreamerList>'
end