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

• #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.

• #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.

• #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

# 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,
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 296

def account_sid
  @properties['account_sid']
end

#codec ⇒ recording.Codec

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 356

def codec
  @properties['codec']
end

#container_format ⇒ recording.Format

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 350

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

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

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 308

def date_created
  @properties['date_created']
end

#delete ⇒ Boolean

Delete the RecordingInstance

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 394

def delete
  context.delete
end

#duration ⇒ String

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 344

def duration
  @properties['duration']
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 387

def fetch
  context.fetch
end

#grouping_sids ⇒ Hash

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 362

def grouping_sids
  @properties['grouping_sids']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 407

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

#links ⇒ String

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

def links
  @properties['links']
end

#offset ⇒ String

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

def offset
  @properties['offset']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 314

def sid
  @properties['sid']
end

#size ⇒ String

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 326

def size
  @properties['size']
end

#source_sid ⇒ String

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 320

def source_sid
  @properties['source_sid']
end

#status ⇒ recording.Status

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 302

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 400

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

#track_name ⇒ String

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

def track_name
  @properties['track_name']
end

#type ⇒ recording.Type

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 338

def type
  @properties['type']
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 332

def url
  @properties['url']
end