Class: Twilio::REST::Video::V1::RoomContext::RoomRecordingInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Video::V1::RoomContext::RoomRecordingInstance
- Defined in:
- lib/twilio-ruby/rest/video/v1/room/room_recording.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the RoomRecording resource.
- #codec ⇒ Codec
- #container_format ⇒ Format
-
#context ⇒ RoomRecordingContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#delete ⇒ Boolean
Delete the RoomRecordingInstance.
-
#duration ⇒ String
The duration of the recording rounded to the nearest second.
-
#fetch ⇒ RoomRecordingInstance
Fetch the RoomRecordingInstance.
-
#grouping_sids ⇒ Hash
A list of SIDs related to the Recording.
-
#initialize(version, payload, room_sid: nil, sid: nil) ⇒ RoomRecordingInstance
constructor
Initialize the RoomRecordingInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of related resources.
-
#media_external_location ⇒ String
The URL of the media file associated with the recording when stored externally.
-
#offset ⇒ 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.
-
#room_sid ⇒ String
The SID of the Room resource the recording is associated with.
-
#sid ⇒ String
The unique string that we created to identify the RoomRecording resource.
-
#size ⇒ String
The size of the recorded track in bytes.
-
#source_sid ⇒ String
The SID of the recording source.
- #status ⇒ Status
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#track_name ⇒ String
The name that was given to the source track of the recording.
- #type ⇒ Type
-
#url ⇒ String
The absolute URL of the resource.
Constructor Details
#initialize(version, payload, room_sid: nil, sid: nil) ⇒ RoomRecordingInstance
Initialize the RoomRecordingInstance
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 258 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
300 301 302 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 300 def account_sid @properties['account_sid'] end |
#codec ⇒ Codec
360 361 362 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 360 def codec @properties['codec'] end |
#container_format ⇒ Format
354 355 356 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 354 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
291 292 293 294 295 296 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 291 def context unless @instance_context @instance_context = RoomRecordingContext.new(@version , @params['room_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
312 313 314 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 312 def date_created @properties['date_created'] end |
#delete ⇒ Boolean
Delete the RoomRecordingInstance
403 404 405 406 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 403 def delete context.delete end |
#duration ⇒ String
348 349 350 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 348 def duration @properties['duration'] end |
#fetch ⇒ RoomRecordingInstance
Fetch the RoomRecordingInstance
411 412 413 414 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 411 def fetch context.fetch end |
#grouping_sids ⇒ Hash
366 367 368 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 366 def grouping_sids @properties['grouping_sids'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
425 426 427 428 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 425 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Video.V1.RoomRecordingInstance #{values}>" end |
#links ⇒ Hash
396 397 398 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 396 def links @properties['links'] end |
#media_external_location ⇒ String
384 385 386 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 384 def media_external_location @properties['media_external_location'] end |
#offset ⇒ String
378 379 380 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 378 def offset @properties['offset'] end |
#room_sid ⇒ String
390 391 392 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 390 def room_sid @properties['room_sid'] end |
#sid ⇒ String
318 319 320 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 318 def sid @properties['sid'] end |
#size ⇒ String
330 331 332 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 330 def size @properties['size'] end |
#source_sid ⇒ String
324 325 326 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 324 def source_sid @properties['source_sid'] end |
#status ⇒ Status
306 307 308 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 306 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
418 419 420 421 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 418 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Video.V1.RoomRecordingInstance #{values}>" end |
#track_name ⇒ String
372 373 374 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 372 def track_name @properties['track_name'] end |
#type ⇒ Type
342 343 344 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 342 def type @properties['type'] end |
#url ⇒ String
336 337 338 |
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 336 def url @properties['url'] end |