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/composition_hook.rb,
lib/twilio-ruby/rest/video/v1/room/participant.rb,
lib/twilio-ruby/rest/video/v1/recording_settings.rb,
lib/twilio-ruby/rest/video/v1/room/room_recording.rb,
lib/twilio-ruby/rest/video/v1/composition_settings.rb,
lib/twilio-ruby/rest/video/v1/room/recording_rules.rb,
lib/twilio-ruby/rest/video/v1/room/participant/anonymize.rb,
lib/twilio-ruby/rest/video/v1/room/participant/published_track.rb,
lib/twilio-ruby/rest/video/v1/room/participant/subscribe_rules.rb,
lib/twilio-ruby/rest/video/v1/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



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 21

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:



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

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:

  • (Twilio::REST::Video::V1::compositionSettingsContext) 


62
63
64
 
# File 'lib/twilio-ruby/rest/video/v1.rb', line 62

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:



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

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:

  • (Twilio::REST::Video::V1::recordingSettingsContext) 


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

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:



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

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:



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

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