Class: Twilio::REST::Video::V1

Inherits:
Twilio::REST::Version show all
Defined in:
lib/twilio-ruby/rest/video/v1.rb,
lib/twilio-ruby/rest/video/v1/room.rb,
lib/twilio-ruby/rest/video/v1/recording.rb,
lib/twilio-ruby/rest/video/v1/composition.rb,
lib/twilio-ruby/rest/video/v1/room/recording.rb,
lib/twilio-ruby/rest/video/v1/recording_settings.rb,
lib/twilio-ruby/rest/video/v1/composition_settings.rb,
lib/twilio-ruby/rest/video/v1/room/room_participant.rb,
lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb,
lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb

Defined Under Namespace

Classes: CompositionContext, CompositionInstance, CompositionList, CompositionPage, CompositionSettingsContext, CompositionSettingsInstance, CompositionSettingsList, CompositionSettingsPage, RecordingContext, RecordingInstance, RecordingList, RecordingPage, RecordingSettingsContext, RecordingSettingsInstance, RecordingSettingsList, RecordingSettingsPage, RoomContext, RoomInstance, RoomList, RoomPage

Instance Attribute Summary

Attributes inherited from Twilio::REST::Version

#domain

Instance Method Summary collapse

Methods inherited from Twilio::REST::Version

#absolute_url, #create, #delete, #exception, #fetch, #page, #read_limits, #relative_uri, #request, #stream, #update

Constructor Details

#initialize(domain) ⇒ V1

Initialize the V1 version of Video



15
16
17
18
19
20
21
22
23
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 15

def initialize(domain)
  super
  @version = 'v1'
  @composition_settings = nil
  @recordings = nil
  @recording_settings = nil
  @compositions = nil
  @rooms = nil
end

Instance Method Details

#composition_settings ⇒ Twilio::REST::Video::V1::CompositionSettingsContext

Returns:



27
28
29
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 27

def composition_settings
  @composition_settings ||= CompositionSettingsContext.new self
end

#compositions(sid = :unset) ⇒ Twilio::REST::Video::V1::CompositionContext, Twilio::REST::Video::V1::CompositionList

Parameters:

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

    The Composition Sid that uniquely identifies the Composition to fetch.

Returns:



57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 57

def compositions(sid=:unset)
  if sid.nil?
    raise ArgumentError, 'sid cannot be nil'
  elsif sid == :unset
    @compositions ||= CompositionList.new self
  else
    CompositionContext.new(self, sid)
  end
end

#recording_settings ⇒ Twilio::REST::Video::V1::RecordingSettingsContext

Returns:



48
49
50
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 48

def recording_settings
  @recording_settings ||= RecordingSettingsContext.new self
end

#recordings(sid = :unset) ⇒ Twilio::REST::Video::V1::RecordingContext, Twilio::REST::Video::V1::RecordingList

Parameters:

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

    The Recording Sid that uniquely identifies the Recording to fetch.

Returns:



36
37
38
39
40
41
42
43
44
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 36

def recordings(sid=:unset)
  if sid.nil?
    raise ArgumentError, 'sid cannot be nil'
  elsif sid == :unset
    @recordings ||= RecordingList.new self
  else
    RecordingContext.new(self, sid)
  end
end

#rooms(sid = :unset) ⇒ Twilio::REST::Video::V1::RoomContext, Twilio::REST::Video::V1::RoomList

Parameters:

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

    The Room Sid or name that uniquely identifies this resource.

Returns:



71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 71

def rooms(sid=:unset)
  if sid.nil?
    raise ArgumentError, 'sid cannot be nil'
  elsif sid == :unset
    @rooms ||= RoomList.new self
  else
    RoomContext.new(self, sid)
  end
end

#to_s ⇒ Object

Provide a user friendly representation



83
84
85
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 83

def to_s
  '<Twilio::REST::Video::V1>'
end