Class: Twilio::REST::Video::V1::RoomInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Video::V1::RoomInstance
- Defined in:
- lib/twilio-ruby/rest/video/v1/room.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#audio_only ⇒ Boolean
Indicates whether the room will only contain audio track participants for group rooms.
-
#context ⇒ RoomContext
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.
-
#date_updated ⇒ Time
The ISO 8601 date and time in GMT when the resource was last updated.
-
#duration ⇒ String
The duration of the room in seconds.
-
#empty_room_timeout ⇒ String
The time a room will remain active after last participant leaves.
-
#enable_turn ⇒ Boolean
Enable Twilio's Network Traversal TURN service.
-
#end_time ⇒ Time
The UTC end time of the room in UTC ISO 8601 format.
-
#fetch ⇒ RoomInstance
Fetch the RoomInstance.
-
#initialize(version, payload, sid: nil) ⇒ RoomInstance
constructor
Initialize the RoomInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#large_room ⇒ Boolean
Indicates if this is a large room.
-
#links ⇒ String
The URLs of related resources.
-
#max_concurrent_published_tracks ⇒ String
The maximum number of published tracks allowed in the room at the same time.
-
#max_participant_duration ⇒ String
The maximum number of seconds a Participant can be connected to the room.
-
#max_participants ⇒ String
The maximum number of concurrent Participants allowed in the room.
-
#media_region ⇒ String
The region for the media server in Group Rooms.
-
#participants ⇒ participants
Access the participants.
-
#record_participants_on_connect ⇒ Boolean
Whether to start recording when Participants connect.
-
#recording_rules ⇒ recording_rules
Access the recording_rules.
-
#recordings ⇒ recordings
Access the recordings.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#status ⇒ room.RoomStatus
The status of the room.
-
#status_callback ⇒ String
The URL to send status information to your application.
-
#status_callback_method ⇒ String
The HTTP method we use to call status_callback.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#type ⇒ room.RoomType
The type of room.
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the resource.
-
#unused_room_timeout ⇒ String
The time a room will remain active when no one joins.
-
#update(status: nil) ⇒ RoomInstance
Update the RoomInstance.
-
#url ⇒ String
The absolute URL of the resource.
-
#video_codecs ⇒ Array[room.VideoCodec]
An array of the video codecs that are supported when publishing a track in the room.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ RoomInstance
Initialize the RoomInstance
367 368 369 370 371 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 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 367 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'].to_i, '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'].to_i, '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 that created the resource.
440 441 442 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 440 def account_sid @properties['account_sid'] end |
#audio_only ⇒ Boolean
Returns Indicates whether the room will only contain audio track participants for group rooms.
524 525 526 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 524 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
407 408 409 410 411 412 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 407 def context unless @instance_context @instance_context = RoomContext.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.
428 429 430 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 428 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The ISO 8601 date and time in GMT when the resource was last updated.
434 435 436 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 434 def date_updated @properties['date_updated'] end |
#duration ⇒ String
Returns The duration of the room in seconds.
476 477 478 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 476 def duration @properties['duration'] end |
#empty_room_timeout ⇒ String
Returns The time a room will remain active after last participant leaves.
530 531 532 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 530 def empty_room_timeout @properties['empty_room_timeout'] end |
#enable_turn ⇒ Boolean
Returns Enable Twilio's Network Traversal TURN service.
446 447 448 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 446 def enable_turn @properties['enable_turn'] end |
#end_time ⇒ Time
Returns The UTC end time of the room in UTC ISO 8601 format.
470 471 472 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 470 def end_time @properties['end_time'] end |
#fetch ⇒ RoomInstance
Fetch the RoomInstance
561 562 563 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 561 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
604 605 606 607 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 604 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.
542 543 544 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 542 def large_room @properties['large_room'] end |
#links ⇒ String
Returns The URLs of related resources.
554 555 556 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 554 def links @properties['links'] end |
#max_concurrent_published_tracks ⇒ String
Returns The maximum number of published tracks allowed in the room at the same time.
500 501 502 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 500 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.
494 495 496 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 494 def max_participant_duration @properties['max_participant_duration'] end |
#max_participants ⇒ String
Returns The maximum number of concurrent Participants allowed in the room.
488 489 490 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 488 def max_participants @properties['max_participants'] end |
#media_region ⇒ String
Returns The region for the media server in Group Rooms.
518 519 520 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 518 def media_region @properties['media_region'] end |
#participants ⇒ participants
Access the participants
584 585 586 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 584 def participants context.participants end |
#record_participants_on_connect ⇒ Boolean
Returns Whether to start recording when Participants connect.
506 507 508 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 506 def record_participants_on_connect @properties['record_participants_on_connect'] end |
#recording_rules ⇒ recording_rules
Access the recording_rules
591 592 593 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 591 def recording_rules context.recording_rules end |
#recordings ⇒ recordings
Access the recordings
577 578 579 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 577 def recordings context.recordings end |
#sid ⇒ String
Returns The unique string that identifies the resource.
416 417 418 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 416 def sid @properties['sid'] end |
#status ⇒ room.RoomStatus
Returns The status of the room.
422 423 424 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 422 def status @properties['status'] end |
#status_callback ⇒ String
Returns The URL to send status information to your application.
458 459 460 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 458 def status_callback @properties['status_callback'] end |
#status_callback_method ⇒ String
Returns The HTTP method we use to call status_callback.
464 465 466 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 464 def status_callback_method @properties['status_callback_method'] end |
#to_s ⇒ Object
Provide a user friendly representation
597 598 599 600 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 597 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Video.V1.RoomInstance #{values}>" end |
#type ⇒ room.RoomType
Returns The type of room.
482 483 484 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 482 def type @properties['type'] end |
#unique_name ⇒ String
Returns An application-defined string that uniquely identifies the resource.
452 453 454 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 452 def unique_name @properties['unique_name'] end |
#unused_room_timeout ⇒ String
Returns The time a room will remain active when no one joins.
536 537 538 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 536 def unused_room_timeout @properties['unused_room_timeout'] end |
#update(status: nil) ⇒ RoomInstance
Update the RoomInstance
570 571 572 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 570 def update(status: nil) context.update(status: status, ) end |
#url ⇒ String
Returns The absolute URL of the resource.
548 549 550 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 548 def url @properties['url'] end |
#video_codecs ⇒ Array[room.VideoCodec]
Returns An array of the video codecs that are supported when publishing a track in the room.
512 513 514 |
# File 'lib/twilio-ruby/rest/video/v1/room.rb', line 512 def video_codecs @properties['video_codecs'] end |