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/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, RecordingContext, RecordingInstance, RecordingList, RecordingPage, 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



13
14
15
16
17
18
19
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 13

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

Instance Method Details

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

Parameters:

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

    The sid

Returns:



25
26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 25

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

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

Parameters:

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

    The sid

Returns:



39
40
41
42
43
44
45
46
47
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 39

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 sid

Returns:



53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 53

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



65
66
67
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 65

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