Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 3.57 KB

RoomPropertiesStreamingEndpointsInner.md

File metadata and controls

28 lines (22 loc) · 3.57 KB
Raw

Daily::RoomPropertiesStreamingEndpointsInner

Properties

Name Type Description Notes
name String Used by the `startLiveStreaming()` API to reference which stream configuration to start. [optional]
type String Whether the streaming endpoint is `rtmp` or `hls`. [optional]
hls_config_storage_path String The `s3Key` path prefix for where to store the recordings. Therefore, the final final master.m3u8 path template is `<bucket_name>/<path>/<mtgSessionId>/master.m3u8`, i.e. `hls_config['storage']['bucket_name']/hls_config['storage']['path']/<mtgSessionId>/master.m3u8`. [optional]
hls_config_storage_path_template String `path_template` is made up of a replacement string with prefixes, suffixes, or both. `path_template` without replacement string is also valid. The currently supported replacements are: - `epoch_time`: The epoch time in seconds (optional) - `domain_name`: Your Daily domain (optional) - `room_name`: The name of the room which is getting recorded (optional) - `mtg_session_id`: The ID of the meeting session which is getting recorded (optional) - `instance_id`: The instance ID of the recording (optional) - `live_streaming_id`: The ID of the live streaming in our DB (optional) The restrictions for defining a recording template are as follows: - The maximum size of the template is 1024 characters - Each replacement parameter should be placed within a curly bracket (e.g., `{domain_name}`) - Only alphanumeric characters `(0-9, A-Z, a-z)` and `.`, `/`, `-`, `_` are valid within the template Examples - Example domain: &quot;myDomain&quot; - Example room: &quot;myRoom&quot; - example hls bucket: &quot;HLS_S3_BUCKET&quot; Example 1: - Template: `my-hls-{domain_name}-{epoch_time}` - Resulting path of master.m3u8: `s3://HLS_S3_BUCKET/my-hls-myDomain-1675842936274/master.m3u8` Example 2: - Template: `{room_name}/{instance_id}/` - Resulting path of master.m3u8: `myRoom/d529cd2f-fbcc-4fb7-b2c0-c4995b1162b6/master.m3u8` [optional]
hls_config_save_hls_recording Boolean If `true`, the live stream will be saved as a recording after streaming has ended. If `false`, the stream is available only until the streaming is live. [optional]
hls_config_variants Array<RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner> An optional array of variants to generate for HLS. For most use cases this property can be omitted as Daily uses sensible defaults. The array defines the resolution, FPS, and bitrate for each variant. The following limitations apply: - There can be a maximum of one variant with 1080p resolution. All other variants must be less than or equal to 720p. - A maximum of four variants can be specified, other than iframe-only stream - We do not support iframe-only variant, at least one full-stream variant is required [optional]

Example

require 'daily-ruby'

instance = Daily::RoomPropertiesStreamingEndpointsInner.new(
  name: rtmp_ivs,
  type: hls,
  hls_config_storage_path: my-bucket-name/my-folder-name,
  hls_config_storage_path_template: null,
  hls_config_save_hls_recording: null,
  hls_config_variants: null
)