Class: Twilio::REST::Video::V1::RoomContext::RoomRecordingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/room/room_recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, room_sid: nil, sid: nil) ⇒ RoomRecordingInstance

Initialize the RoomRecordingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this RoomRecording resource.

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

    The SID of the Call resource to fetch.



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 247

def initialize(version, payload , room_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'status' => payload['status'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'sid' => payload['sid'],
        'source_sid' => payload['source_sid'],
        'size' => payload['size'],
        'url' => payload['url'],
        'type' => payload['type'],
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'container_format' => payload['container_format'],
        'codec' => payload['codec'],
        'grouping_sids' => payload['grouping_sids'],
        'track_name' => payload['track_name'],
        'offset' => payload['offset'],
        'media_external_location' => payload['media_external_location'],
        'room_sid' => payload['room_sid'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'room_sid' => room_sid  || @properties['room_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the RoomRecording resource.

Returns:



289
290
291
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 289

def 
    @properties['account_sid']
end

#codec ⇒ Codec

Returns:

  • (Codec) 


349
350
351
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 349

def codec
    @properties['codec']
end

#container_format ⇒ Format

Returns:

  • (Format) 


343
344
345
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 343

def container_format
    @properties['container_format']
end

#context ⇒ RoomRecordingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 280

def context
    unless @instance_context
        @instance_context = RoomRecordingContext.new(@version , @params['room_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



301
302
303
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 301

def date_created
    @properties['date_created']
end

#delete ⇒ Boolean

Delete the RoomRecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



392
393
394
395
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 392

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of the recording rounded to the nearest second. Sub-second duration tracks have a ‘duration` of 1 second.

Returns:

  • (String) —

    The duration of the recording rounded to the nearest second. Sub-second duration tracks have a ‘duration` of 1 second



337
338
339
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 337

def duration
    @properties['duration']
end

#fetch ⇒ RoomRecordingInstance

Fetch the RoomRecordingInstance

Returns:



400
401
402
403
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 400

def fetch

    context.fetch
end

#grouping_sids ⇒ Hash

Returns A list of SIDs related to the Recording. Includes the ‘room_sid` and `participant_sid`.

Returns:

  • (Hash) —

    A list of SIDs related to the Recording. Includes the ‘room_sid` and `participant_sid`.



355
356
357
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 355

def grouping_sids
    @properties['grouping_sids']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



414
415
416
417
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 414

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Video.V1.RoomRecordingInstance #{values}>"
end

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



385
386
387
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 385

def links
    @properties['links']
end

#media_external_location ⇒ String

Returns The URL of the media file associated with the recording when stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) for more details.

Returns:

  • (String) —

    The URL of the media file associated with the recording when stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) for more details.



373
374
375
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 373

def media_external_location
    @properties['media_external_location']
end

#offset ⇒ String

Returns The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room.

Returns:

  • (String) —

    The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room.



367
368
369
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 367

def offset
    @properties['offset']
end

#room_sid ⇒ String

Returns The SID of the Room resource the recording is associated with.

Returns:

  • (String) —

    The SID of the Room resource the recording is associated with.



379
380
381
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 379

def room_sid
    @properties['room_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the RoomRecording resource.

Returns:

  • (String) —

    The unique string that we created to identify the RoomRecording resource.



307
308
309
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 307

def sid
    @properties['sid']
end

#size ⇒ String

Returns The size of the recorded track in bytes.

Returns:

  • (String) —

    The size of the recorded track in bytes.



319
320
321
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 319

def size
    @properties['size']
end

#source_sid ⇒ String

Returns The SID of the recording source. For a Room Recording, this value is a ‘track_sid`.

Returns:

  • (String) —

    The SID of the recording source. For a Room Recording, this value is a ‘track_sid`.



313
314
315
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 313

def source_sid
    @properties['source_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


295
296
297
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 295

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



407
408
409
410
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 407

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Video.V1.RoomRecordingInstance #{values}>"
end

#track_name ⇒ String

Returns The name that was given to the source track of the recording. If no name is given, the ‘source_sid` is used.

Returns:

  • (String) —

    The name that was given to the source track of the recording. If no name is given, the ‘source_sid` is used.



361
362
363
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 361

def track_name
    @properties['track_name']
end

#type ⇒ Type

Returns:

  • (Type) 


331
332
333
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 331

def type
    @properties['type']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



325
326
327
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 325

def url
    @properties['url']
end