Streaming (Egress Protocols)
Last updated
Last updated
The Streaming Settings page allows you to manage the various Engress Protocols provided by OvenMediaEngine.
OvenMediaEngine Enterprise provides sub-second latency streaming using WebRTC.
The WebRTC Streaming Settings allows you to see and modify the WebRTC/WHIP Protocol information and activation status to be used for each application.
Since Signalling is required to exchange SDP in WebRTC, OvenMediaEngine has an embedded WebSocket-based Signalling Server and provides its own defined Signaling Protocol. In the WebRTC/WHIP Settings, you can set the Port to be used for Signaling.
Port: The Port that the server will use to receive HTTP requests
TLS Port: Data is encrypted using the Transport Layer Security (TLS) Protocol between the web browser and the server. The encrypted data is transmitted over the Port.
Worker Count: Sets the number of threads to use for data processing.
WebRTC uses ICE for connections and specifically NAT traversal. The web browser or player exchanges the Ice Candidate with each other in the Signalling phase. Therefore, OvenMediaEngine provides an ICE for WebRTC connectivity.
IceCandidate Ports: This function transfers the Candidate information set in IceCandidate to the WebRTC Peer and sets the IP:Port that the WebRTC Peer uses to request communication with the Candidate.
TCP Relay Port: WebRTC basically works on UDP, but OvenMediaEngine has an embedded TURN Server for WebRTC/TCP so that WebRTC can work on TCP. The TURN Client of the Player can receive or transmit streams using the TCP Session that connects to the TURN Server, and this is a function to set the IP:Port used for communication.
TCP Force: When transporting WebRTC over TCP, a URL pattern like ws[s]://<host>[:port]/<app name>/<stream name>?direction=send&transport=tcp is used. When the TCP Force option is set to True, this option allows TCP operations even when the transport=tcp query string is omitted from the URL pattern.
Worker Count: Sets the number of threads to use for data processing.
Timeout: ICE (STUN request/response) timeout as milliseconds, if there is no request or response during this time, the session is terminated. The default is 30000.
Retransmission: WebRTC uses UDP to transmit Media Data. When transmitting data in UDP, it is designed to skip the Handshake procedure and discard the Over Packet and Damaged Packet in order to ensure high speed and high efficiency. If you enable the Retransmission option, you can detect packet loss by utilizing RTCP (Real-time Transport Control Protocol) within WebRTC and retransmit packets that were dropped due to loss, etc.
Retransmission reduces overall communication delay by retransmitting only necessary packets, enabling effective communication even in unstable network environments. However, packet retransmission generates additional network traffic, so it needs to be managed appropriately considering network conditions and traffic load.
The Retransmission option is useful for WebRTC/UDP, but not for WebRTC/TCP.
UDP FEC: As explained in Retransmission above, there may be loss when transmitting data using UDP. Enabling the UDP FEC option enables the Forward Error Correction (FEC) feature, which adds error correction codes before transmitting data. FEC allows the receiver to restore the original data even if some data is lost or corrupted.
FEC slightly increases the amount of data size that must be transmitted because it adds error correction codes, but it uses network bandwidth more efficiently because errors can be corrected immediately without retransmitting packets and delay.
The UDP FEC option is useful for WebRTC/UDP, but not for WebRTC/TCP.
Jitter Buffer: This is an option to use Jitter Buffer to synchronize the stream when Audio and Video are transmitted at different speeds and conditions. For example, if the video packet arrives later than the audio packet, the audio packet can be delayed for a while to adjust the A/V stream to be played simultaneously.
Apple announced Low-Latency HLS (LLHLS), which enables streaming with a latency of about 2 to 6 seconds while maintaining scalability, and OvenMediaEngine provides low-latency streaming using LLHLS starting from version 0.14.0.
The LLHLS Streaming Settings page allows you to check and modify the LLHLS Protocol information and activation status to be used for each Application.
Port: The Port that the server will use to receive HTTP requests
TLS Port: Data is encrypted using the Transport Layer Security (TLS) Protocol between the web browser and the server. The encrypted data is transmitted over the Port.
Worker Count: Sets the number of threads to use for data processing.
Chunk Duration: Sets the partial segment length to fractional seconds. This value affects low-latency HLS Players. We recommend 0.2 seconds for this value.
Segment Duration: Sets the length of the segment in seconds. Therefore, a shorter value allows the stream to start faster. However, a value that is too short will make legacy HLS players unstable. Apple recommends 6 seconds for this value.
Segment Count: The number of segments listed in the playlist. This value has little effect on LLHLS players, so use 10 as Apple recommends. 5 is recommended for legacy HLS Players.
Do not set below 3. It can only be used for experimentation.
Part HoldBack: Sets the segment length to be sent in advance in fractional seconds.
Origin Mode: Specifies the stream as the origin.
You can create as long playlists as you want by enabling the Digital Video Recorder (DVR) option in the LLHLS Publisher in Server.xml. This option allows the Player to rewind the stream while it is live (Live Rewind).
You can check the option information and activation status through the DVR item on the LLHLS Streaming Settings.
Storage Path: Set the path to store the segments to prevent memory overuse and over-occupancy by making a playlist that is too long.
Max Duration: The playlist is stored for the time set in Max Duration, and the unit is seconds.
LLHLS Dump is a feature that allows you to dump the .m3u8 and all track segments when the stream is played back as LLHLS so that the file can be served to VoD immediately up to the dumped point even while it is live. You can use this feature by enabling the Dump option in LLHLS Publisher in Server.xml.
You can see the option information and activation status through the DUMP on the LLHLS Streaming Settings page.
Enable: Sets enable or disable the LLHLS Dump feature.
Target Stream Name: The name of the stream to dump to. You can use * and ? to filter stream names.
Playlists: The name of the master playlist file to be dumped together.
Output Path: Specify the path and file name to save the dumped file. You must have written permission in the specified folder.
Digital Rights Management (DRM) is a technology used to prevent unauthorized use, copying, and distribution of digital content. Starting with OvenMediaEngine version 0.16.0 or later, you can apply DRM Vendors (Widevine, Fairplay) to LLHLS Stream through simple settings.
Currently, DRM is only supported for H.264 and AAC codecs. H.265 support will be added soon.
The Legacy HLS Streaming Settings page allows you to check and modify the HLS Protocol information and activation status to be used for each Application.
Port: The Port that the server will use to receive HTTP requests
TLS Port: Data is encrypted using the Transport Layer Security (TLS) Protocol between the web browser and the server. The encrypted data is transmitted over the Port.
Worker Count: Sets the number of threads to use for data processing.
Segment Duration: Sets the length of the segment in seconds. Therefore, a shorter value allows the stream to start faster. However, a value that is too short will make legacy HLS players unstable. Apple recommends 6 seconds for this value.
Segment Count: The number of segments listed in the playlist. 5 is recommended for HLS players.
Do not set below 3. It can only be used for experimentation.
Origin Mode: Specifies the stream as the origin.
You can view the option information and activation status through the DVR item on the Legacy HLS Streaming Settings page.
Storage Path: Set the path to store the segments to prevent memory overuse and over-occupancy by making a playlist that is too long.
Max Duration: The playlist is stored for the time set in Max Duration, and the unit is seconds.
Signalling Guide:
ICE Guide:
WebRTC Publisher Guide:
Create Default Playlist: You can control whether each playback protocol (LL-HLS, Legacy HLS, WebRTC) creates a Playlist (llhls, playlist, webrtc) by default. See the detailed guide for more information.
Detailed Guide:
Cross Domain: Controls the domain in which the player works through <CorssDomain>. For more information, please refer to the .
Cache Control: You can specify how long content is cached on the Edge Server or CDN Cache Server by adding a Cache-Control header to the HTTP response. For more information, see the guide.
Create Default Playlist: You can control whether each playback protocol (LL-HLS, Legacy HLS, WebRTC) creates a default playlist (llhls, playlist, webrtc). For more information, see the guide.
Default Query String: You can control the default behavior for Low-Latency HLS (or Legacy HLS) via <DefaultQueryString>. For more information, see the guide.
Propagate Query String: If you enable <PropagateQueryString>, the query string included in the initial master playlist request will be automatically included in all subrequests (media playlists, segments, and partial segments). For more information, see the guide.
ServerTime Based Segment Numbering: Origin redundancy allows the Edge Server or CDN Cache Server to connect to the Secondary Origin Server instead of the Primary Origin Server to download the same content if the Primary Origin Server fails. For more information, see the .
Detailed Guide:
LLHLS DVR Guide:
LLHLS Dump Guide:
You can check the option information and activation status through the DRM on the LLHLS Streaming Settings page. OvenMediaEngine Enterprise also supports not only DRM Vendor integration but also such as PallyCon DRM.
LLHLS DRM Guide:
Since HLS based on MPEG-2 TS containers still provides broad compatibility, including support for older devices, the OME Enterprise team decided to support HLS version 3+ based on MPEG-2 TS containers starting with (updated on July 5, 2024).
Detailed Guide:
Cross Domain: Controls the domain in which the player works through <CorssDomain>. For more information, please refer to the .
HLS Corss Domain Guide:
Create Default Playlist: You can control whether each playback protocol (LL-HLS, Legacy HLS, WebRTC) creates a default playlist (llhls, playlist, webrtc). For more information, see the guide.
Default Query String: You can control the default behavior for Low-Latency HLS (or Legacy HLS) via <DefaultQueryString>. For more information, see the guide.
Propagate Query String: If you enable <PropagateQueryString>, the query string included in the initial master playlist request will be automatically included in all subrequests (media playlists, segments, and partial segments). For more information, see the guide.
ServerTime Based Segment Numbering: Origin redundancy allows the Edge Server or CDN Cache Server to connect to the Secondary Origin Server instead of the Primary Origin Server to download the same content if the Primary Origin Server fails. For more information, see the .
HLS DVR Guide:
