Class: Twilio::REST::Video::V1::RoomInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ RoomInstance

Initialize the RoomInstance

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 Room resource.

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

    The SID of the Call resource to fetch.



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 372

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'status' => payload['status'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'account_sid' => payload['account_sid'],
        'enable_turn' => payload['enable_turn'],
        'unique_name' => payload['unique_name'],
        'status_callback' => payload['status_callback'],
        'status_callback_method' => payload['status_callback_method'],
        'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'type' => payload['type'],
        'max_participants' => payload['max_participants'] == nil ? payload['max_participants'] : payload['max_participants'].to_i,
        'max_participant_duration' => payload['max_participant_duration'] == nil ? payload['max_participant_duration'] : payload['max_participant_duration'].to_i,
        'max_concurrent_published_tracks' => payload['max_concurrent_published_tracks'] == nil ? payload['max_concurrent_published_tracks'] : payload['max_concurrent_published_tracks'].to_i,
        'record_participants_on_connect' => payload['record_participants_on_connect'],
        'video_codecs' => payload['video_codecs'],
        'media_region' => payload['media_region'],
        'audio_only' => payload['audio_only'],
        'empty_room_timeout' => payload['empty_room_timeout'] == nil ? payload['empty_room_timeout'] : payload['empty_room_timeout'].to_i,
        'unused_room_timeout' => payload['unused_room_timeout'] == nil ? payload['unused_room_timeout'] : payload['unused_room_timeout'].to_i,
        'large_room' => payload['large_room'],
        'url' => payload['url'],
        '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](www.twilio.com/docs/iam/api/account) that created the Room resource.

Returns:



445
446
447
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 445

def 
    @properties['account_sid']
end

#audio_only ⇒ Boolean

Returns When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.

Returns:

  • (Boolean) —

    When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.



529
530
531
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 529

def audio_only
    @properties['audio_only']
end

#context ⇒ RoomContext

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

Returns:



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

def context
    unless @instance_context
        @instance_context = RoomContext.new(@version , @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:



433
434
435
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 433

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



439
440
441
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 439

def date_updated
    @properties['date_updated']
end

#duration ⇒ String

Returns The duration of the room in seconds.

Returns:

  • (String) —

    The duration of the room in seconds.



481
482
483
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 481

def duration
    @properties['duration']
end

#empty_room_timeout ⇒ String

Returns Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.

Returns:

  • (String) —

    Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.



535
536
537
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 535

def empty_room_timeout
    @properties['empty_room_timeout']
end

#enable_turn ⇒ Boolean

Returns Deprecated, now always considered to be true.

Returns:

  • (Boolean) —

    Deprecated, now always considered to be true.



451
452
453
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 451

def enable_turn
    @properties['enable_turn']
end

#end_time ⇒ Time

Returns The UTC end time of the room in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

Returns:



475
476
477
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 475

def end_time
    @properties['end_time']
end

#fetch ⇒ RoomInstance

Fetch the RoomInstance

Returns:



566
567
568
569
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 566

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



614
615
616
617
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 614

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

#large_room ⇒ Boolean

Returns Indicates if this is a large room.

Returns:

  • (Boolean) —

    Indicates if this is a large room.



547
548
549
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 547

def large_room
    @properties['large_room']
end

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



559
560
561
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 559

def links
    @properties['links']
end

#max_concurrent_published_tracks ⇒ String

Returns The maximum number of published audio, video, and data tracks all participants combined are allowed to publish in the room at the same time. Check [Programmable Video Limits](www.twilio.com/docs/video/programmable-video-limits) for more details. If it is set to 0 it means unconstrained.

Returns:

  • (String) —

    The maximum number of published audio, video, and data tracks all participants combined are allowed to publish in the room at the same time. Check [Programmable Video Limits](www.twilio.com/docs/video/programmable-video-limits) for more details. If it is set to 0 it means unconstrained.



505
506
507
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 505

def max_concurrent_published_tracks
    @properties['max_concurrent_published_tracks']
end

#max_participant_duration ⇒ String

Returns The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours).

Returns:

  • (String) —

    The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours).



499
500
501
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 499

def max_participant_duration
    @properties['max_participant_duration']
end

#max_participants ⇒ String

Returns The maximum number of concurrent Participants allowed in the room.

Returns:

  • (String) —

    The maximum number of concurrent Participants allowed in the room.



493
494
495
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 493

def max_participants
    @properties['max_participants']
end

#media_region ⇒ String

Returns The region for the Room’s media server. Can be one of the [available Media Regions](www.twilio.com/docs/video/ip-addresses#media-servers).

Returns:



523
524
525
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 523

def media_region
    @properties['media_region']
end

#participants ⇒ participants

Access the participants

Returns:



594
595
596
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 594

def participants
    context.participants
end

#record_participants_on_connect ⇒ Boolean

Returns Whether to start recording when Participants connect.

Returns:

  • (Boolean) —

    Whether to start recording when Participants connect.



511
512
513
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 511

def record_participants_on_connect
    @properties['record_participants_on_connect']
end

#recording_rules ⇒ recording_rules

Access the recording_rules

Returns:



587
588
589
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 587

def recording_rules
    context.recording_rules
end

#recordings ⇒ recordings

Access the recordings

Returns:



601
602
603
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 601

def recordings
    context.recordings
end

#sid ⇒ String

Returns The unique string that Twilio created to identify the Room resource.

Returns:

  • (String) —

    The unique string that Twilio created to identify the Room resource.



421
422
423
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 421

def sid
    @properties['sid']
end

#status ⇒ RoomStatus

Returns:

  • (RoomStatus) 


427
428
429
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 427

def status
    @properties['status']
end

#status_callback ⇒ String

Returns The URL Twilio calls using the ‘status_callback_method` to send status information to your application on every room event. See [Status Callbacks](www.twilio.com/docs/video/api/status-callbacks) for more info.

Returns:



463
464
465
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 463

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method Twilio uses to call ‘status_callback`. Can be `POST` or `GET` and defaults to `POST`.

Returns:

  • (String) —

    The HTTP method Twilio uses to call ‘status_callback`. Can be `POST` or `GET` and defaults to `POST`.



469
470
471
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 469

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



607
608
609
610
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 607

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

#type ⇒ RoomType

Returns:

  • (RoomType) 


487
488
489
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 487

def type
    @properties['type']
end

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used as a ‘room_sid` in place of the resource’s ‘sid` in the URL to address the resource, assuming it does not contain any [reserved characters](tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used as a ‘room_sid` in place of the resource’s ‘sid` in the URL to address the resource, assuming it does not contain any [reserved characters](tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`.



457
458
459
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 457

def unique_name
    @properties['unique_name']
end

#unused_room_timeout ⇒ String

Returns Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.

Returns:

  • (String) —

    Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.



541
542
543
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 541

def unused_room_timeout
    @properties['unused_room_timeout']
end

#update(status: nil) ⇒ RoomInstance

Update the RoomInstance

Parameters:

  • status (RoomStatus) (defaults to: nil)

Returns:



575
576
577
578
579
580
581
582
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 575

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



553
554
555
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 553

def url
    @properties['url']
end

#video_codecs ⇒ Array<VideoCodec>

Returns An array of the video codecs that are supported when publishing a track in the room. Can be: ‘VP8` and `H264`.

Returns:

  • (Array<VideoCodec>) —

    An array of the video codecs that are supported when publishing a track in the room. Can be: ‘VP8` and `H264`.



517
518
519
 
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 517

def video_codecs
    @properties['video_codecs']
end