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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/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

  • room_sid (String) (defaults to: nil)

    The room_sid

  • sid (String) (defaults to: nil)

    The sid



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 235

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'] == nil ? payload['size'] : payload['size'].to_i,
      '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'],
      'room_sid' => payload['room_sid'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid



281
282
283
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 281

def 
  @properties['account_sid']
end

#codecroom_recording.Codec

Returns The codec.

Returns:

  • (room_recording.Codec)

    The codec



335
336
337
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 335

def codec
  @properties['codec']
end

#container_formatroom_recording.Format

Returns The container_format.

Returns:

  • (room_recording.Format)

    The container_format



329
330
331
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 329

def container_format
  @properties['container_format']
end

#contextRoomRecordingContext

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

Returns:



268
269
270
271
272
273
274
275
276
277
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 268

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

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created



293
294
295
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 293

def date_created
  @properties['date_created']
end

#durationString

Returns The duration.

Returns:

  • (String)

    The duration



323
324
325
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 323

def duration
  @properties['duration']
end

#fetchRoomRecordingInstance

Fetch a RoomRecordingInstance

Returns:



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

def fetch
  context.fetch
end

#grouping_sidsHash

Returns The grouping_sids.

Returns:

  • (Hash)

    The grouping_sids



341
342
343
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 341

def grouping_sids
  @properties['grouping_sids']
end

#inspectObject

Provide a detailed, user friendly representation



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

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

Returns The links.

Returns:

  • (String)

    The links



359
360
361
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 359

def links
  @properties['links']
end

#room_sidString

Returns The room_sid.

Returns:

  • (String)

    The room_sid



347
348
349
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 347

def room_sid
  @properties['room_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



299
300
301
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 299

def sid
  @properties['sid']
end

#sizeString

Returns The size.

Returns:

  • (String)

    The size



311
312
313
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 311

def size
  @properties['size']
end

#source_sidString

Returns The source_sid.

Returns:

  • (String)

    The source_sid



305
306
307
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 305

def source_sid
  @properties['source_sid']
end

#statusroom_recording.Status

Returns The status.

Returns:

  • (room_recording.Status)

    The status



287
288
289
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 287

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation



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

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

#typeroom_recording.Type

Returns The type.

Returns:

  • (room_recording.Type)

    The type



317
318
319
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 317

def type
  @properties['type']
end

#urlString

Returns The url.

Returns:

  • (String)

    The url



353
354
355
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 353

def url
  @properties['url']
end