Sha256: 9fca2d44792ea0de2ba33e4d88889c404f24f84cbacc0d2c80b1e1d499010ddb

Contents?: true

Size: 1.09 KB

Versions: 17

Compression:

Stored size: 1.09 KB

Contents

# MuxRuby::Broadcast

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | Unique identifier for the broadcast. Max 255 characters. |  |
| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
| **live_stream_id** | **String** | The ID of the live stream that the broadcast will be sent to. |  |
| **status** | [**BroadcastStatus**](BroadcastStatus.md) |  |  |
| **layout** | [**BroadcastLayout**](BroadcastLayout.md) |  | [default to 'gallery'] |
| **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
| **resolution** | [**BroadcastResolution**](BroadcastResolution.md) |  | [default to '1920x1080'] |

## Example

```ruby
require 'mux_ruby'

instance = MuxRuby::Broadcast.new(
  id: null,
  passthrough: null,
  live_stream_id: null,
  status: null,
  layout: null,
  background: null,
  resolution: null
)
```

Version data entries

17 entries across 17 versions & 1 rubygems

Version Path
mux_ruby-3.20.0 docs/Broadcast.md
mux_ruby-3.19.0 docs/Broadcast.md
mux_ruby-3.18.0 docs/Broadcast.md
mux_ruby-3.17.0 docs/Broadcast.md
mux_ruby-3.15.0 docs/Broadcast.md
mux_ruby-3.14.0 docs/Broadcast.md
mux_ruby-3.13.0 docs/Broadcast.md
mux_ruby-3.12.0 docs/Broadcast.md
mux_ruby-3.11.1 docs/Broadcast.md
mux_ruby-3.11.0 docs/Broadcast.md
mux_ruby-3.9.0 docs/Broadcast.md
mux_ruby-3.8.0 docs/Broadcast.md
mux_ruby-3.7.0 docs/Broadcast.md
mux_ruby-3.6.0 docs/Broadcast.md
mux_ruby-3.5.2 docs/Broadcast.md
mux_ruby-3.5.1 docs/Broadcast.md
mux_ruby-3.5.0 docs/Broadcast.md