Class: Twilio::REST::Video::V1::RecordingInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Video::V1::RecordingInstance
- Defined in:
- lib/twilio-ruby/rest/video/v1/recording.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#codec ⇒ recording.Codec
The codec used to encode the track.
-
#container_format ⇒ recording.Format
The file format for the recording.
-
#context ⇒ RecordingContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The ISO 8601 date and time in GMT when the resource was created.
-
#delete ⇒ Boolean
Delete the RecordingInstance.
-
#duration ⇒ String
The duration of the recording in seconds.
-
#fetch ⇒ RecordingInstance
Fetch the RecordingInstance.
-
#grouping_sids ⇒ Hash
A list of SIDs related to the recording.
-
#initialize(version, payload, sid: nil) ⇒ RecordingInstance
constructor
Initialize the RecordingInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ String
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 number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#size ⇒ String
The size of the recorded track, in bytes.
-
#source_sid ⇒ String
The SID of the recording source.
-
#status ⇒ recording.Status
The status of the recording.
-
#status_callback ⇒ String
The URL called to send status information on every recording event.
-
#status_callback_method ⇒ String
The HTTP method used to call `status_callback`.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#track_name ⇒ String
The name that was given to the source track of the recording.
-
#type ⇒ recording.Type
The recording's media type.
-
#url ⇒ String
The absolute URL of the resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ RecordingInstance
Initialize the RecordingInstance
256 257 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 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 256 def initialize(version, payload, 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'].to_i, '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'].to_i, 'media_external_location' => payload['media_external_location'], 'status_callback' => payload['status_callback'], 'status_callback_method' => payload['status_callback_method'], 'links' => payload['links'], } # Context @instance_context = nil @params = {'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the Account that created the resource.
299 300 301 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 299 def account_sid @properties['account_sid'] end |
#codec ⇒ recording.Codec
Returns The codec used to encode the track.
359 360 361 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 359 def codec @properties['codec'] end |
#container_format ⇒ recording.Format
Returns The file format for the recording.
353 354 355 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 353 def container_format @properties['container_format'] end |
#context ⇒ RecordingContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
290 291 292 293 294 295 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 290 def context unless @instance_context @instance_context = RecordingContext.new(@version, @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The ISO 8601 date and time in GMT when the resource was created.
311 312 313 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 311 def date_created @properties['date_created'] end |
#delete ⇒ Boolean
Delete the RecordingInstance
415 416 417 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 415 def delete context.delete end |
#duration ⇒ String
Returns The duration of the recording in seconds.
347 348 349 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 347 def duration @properties['duration'] end |
#fetch ⇒ RecordingInstance
Fetch the RecordingInstance
408 409 410 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 408 def fetch context.fetch end |
#grouping_sids ⇒ Hash
Returns A list of SIDs related to the recording.
365 366 367 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 365 def grouping_sids @properties['grouping_sids'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
428 429 430 431 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 428 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Video.V1.RecordingInstance #{values}>" end |
#links ⇒ String
Returns The URLs of related resources.
401 402 403 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 401 def links @properties['links'] end |
#media_external_location ⇒ String
Returns The URL of the media file associated with the recording when stored externally.
383 384 385 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 383 def media_external_location @properties['media_external_location'] end |
#offset ⇒ String
Returns The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started.
377 378 379 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 377 def offset @properties['offset'] end |
#sid ⇒ String
Returns The unique string that identifies the resource.
317 318 319 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 317 def sid @properties['sid'] end |
#size ⇒ String
Returns The size of the recorded track, in bytes.
329 330 331 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 329 def size @properties['size'] end |
#source_sid ⇒ String
Returns The SID of the recording source.
323 324 325 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 323 def source_sid @properties['source_sid'] end |
#status ⇒ recording.Status
Returns The status of the recording.
305 306 307 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 305 def status @properties['status'] end |
#status_callback ⇒ String
Returns The URL called to send status information on every recording event.
389 390 391 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 389 def status_callback @properties['status_callback'] end |
#status_callback_method ⇒ String
Returns The HTTP method used to call `status_callback`.
395 396 397 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 395 def status_callback_method @properties['status_callback_method'] end |
#to_s ⇒ Object
Provide a user friendly representation
421 422 423 424 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 421 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Video.V1.RecordingInstance #{values}>" end |
#track_name ⇒ String
Returns The name that was given to the source track of the recording.
371 372 373 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 371 def track_name @properties['track_name'] end |
#type ⇒ recording.Type
Returns The recording's media type.
341 342 343 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 341 def type @properties['type'] end |
#url ⇒ String
Returns The absolute URL of the resource.
335 336 337 |
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 335 def url @properties['url'] end |