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/composition_hook.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_recording_rule.rb,
lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.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, CompositionHookContext, CompositionHookInstance, CompositionHookList, CompositionHookPage, 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
24
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 15

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

Instance Method Details

#composition_hooks(sid = :unset) ⇒ Twilio::REST::Video::V1::CompositionHookContext, Twilio::REST::Video::V1::CompositionHookList

Parameters:

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

    The SID of the CompositionHook resource to fetch.

Returns:


45
46
47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 45

def composition_hooks(sid=:unset)
  if sid.nil?
      raise ArgumentError, 'sid cannot be nil'
  end
  if sid == :unset
      @composition_hooks ||= CompositionHookList.new self
  else
      CompositionHookContext.new(self, sid)
  end
end

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

Returns:


58
59
60
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 58

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 SID of the Composition resource to fetch.

Returns:


30
31
32
33
34
35
36
37
38
39
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 30

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

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

Returns:


79
80
81
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 79

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 SID of the Recording resource to fetch.

Returns:


66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 66

def recordings(sid=:unset)
  if sid.nil?
      raise ArgumentError, 'sid cannot be nil'
  end
  if 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 of the Room resource to fetch.

Returns:


87
88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 87

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

#to_s ⇒ Object

Provide a user friendly representation


100
101
102
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 100

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