Creating a Pipe Room through the Hop API. Rooms are Pipe’s abstraction of streams.
ephemeral
, Rooms will automatically delete after 10 minutes of no input
stream. You can also delete them programatically through our API or SDK.
field | type | description |
---|---|---|
id | string | hop-generated room ID |
name | ?string | optional room name |
ephemeral | boolean | is this room temporary? |
ingest_protocol | string | one of: rtp, rtmp, srtp |
delivery_protocols | string[] | an array of supported delivery protocols (llhls, webrtc) |
join_token | string | room join token |
state | string | ”live” or “offline” |
ingest_endpoint | string | room ingest endpoint (stream to this!) |
ingest_region | region (string) | the region where the primary ingest is hosted |
llhls_config | ?llhls_config | custom LLHLS configuration options |
webrtc_config | // TODO: @alii ping me once finished with rtc config in sdk | custom WebRTC configuration options |