Sha256: d48e942657ad80603071fc1e01b2d4840425f4e9d5a7f84471d90ec7d7c3f7cc

Contents?: true

Size: 978 Bytes

Versions: 17

Compression:

Stored size: 978 Bytes

Contents

# MuxRuby::CreateBroadcastRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **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 you want to broadcast to. |  |
| **layout** | [**BroadcastLayout**](BroadcastLayout.md) |  | [optional][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) |  | [optional][default to '1920x1080'] |

## Example

```ruby
require 'mux_ruby'

instance = MuxRuby::CreateBroadcastRequest.new(
  passthrough: null,
  live_stream_id: 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/CreateBroadcastRequest.md
mux_ruby-3.19.0 docs/CreateBroadcastRequest.md
mux_ruby-3.18.0 docs/CreateBroadcastRequest.md
mux_ruby-3.17.0 docs/CreateBroadcastRequest.md
mux_ruby-3.15.0 docs/CreateBroadcastRequest.md
mux_ruby-3.14.0 docs/CreateBroadcastRequest.md
mux_ruby-3.13.0 docs/CreateBroadcastRequest.md
mux_ruby-3.12.0 docs/CreateBroadcastRequest.md
mux_ruby-3.11.1 docs/CreateBroadcastRequest.md
mux_ruby-3.11.0 docs/CreateBroadcastRequest.md
mux_ruby-3.9.0 docs/CreateBroadcastRequest.md
mux_ruby-3.8.0 docs/CreateBroadcastRequest.md
mux_ruby-3.7.0 docs/CreateBroadcastRequest.md
mux_ruby-3.6.0 docs/CreateBroadcastRequest.md
mux_ruby-3.5.2 docs/CreateBroadcastRequest.md
mux_ruby-3.5.1 docs/CreateBroadcastRequest.md
mux_ruby-3.5.0 docs/CreateBroadcastRequest.md