← Complete Reference

NGINX RTMP module

118 — Every core and module directive — syntax, defaults, contexts, and real configuration examples.

118 shown
access_log The `access_log` directive in the NGINX RTMP module enables logging of access… ack_window The 'ack_window' directive defines the software acknowledgment window size for… allow The 'allow' directive in the NGINX RTMP module restricts streaming access by… application The 'application' directive in the NGINX RTMP module defines a streaming… buffer The `buffer` directive controls the size of the internal buffer for DASH… buflen The 'buflen' directive specifies the buffer length for RTMP streams in the… busy The 'busy' directive in the NGINX RTMP module controls handling of… chunk_size The `chunk_size` directive specifies the size of the RTMP chunk that is used… dash The 'dash' directive enables support for MPEG-DASH within an NGINX RTMP… dash_cleanup The dash_cleanup directive enables the cleanup of old MPEG-DASH segments after… dash_fragment The `dash_fragment` directive sets the length of each DASH fragment in… dash_nested The 'dash_nested' directive enables or disables nested DASH packaging for… dash_path The 'dash_path' directive defines the storage path for DASH streaming files. dash_playlist_length The `dash_playlist_length` directive defines the maximum length of the DASH… deny The `deny` directive in the NGINX RTMP module restricts access to stream… drop_idle_publisher The `drop_idle_publisher` directive allows NGINX to disconnect idle publishers… exec The `exec` directive in the NGINX RTMP module allows the execution of external… exec_block The `exec_block` directive allows the execution of external commands in… exec_kill_signal The exec_kill_signal directive allows configuration of the signal sent to a… exec_options The exec_options directive in the NGINX RTMP module specifies execution… exec_play The exec_play directive in the NGINX RTMP module allows the execution of… exec_play_done Executes specified external commands/scripts when a playback is completed in… exec_publish The exec_publish directive in the NGINX RTMP module allows the execution of… exec_publish_done The exec_publish_done directive allows execution of a specified command after… exec_pull The exec_pull directive allows integration of external scripts or commands… exec_push The exec_push directive in the NGINX RTMP module allows executing external… exec_record_done The exec_record_done directive specifies commands to be executed when a… exec_static The exec_static directive allows the NGINX RTMP module to execute external… hls Enables MPEG-DASH support for live streaming in the NGINX RTMP module. hls_audio_buffer_size Sets the audio buffer size for live audio streaming in the NGINX RTMP module. hls_base_url The `hls_base_url` directive sets the base URL for HLS (HTTP Live Streaming)… hls_cleanup The hls_cleanup directive controls whether HLS segments are automatically… hls_continuous The `hls_continuous` directive enables or disables continuous HLS streaming in… hls_fragment Sets the duration of each HLS fragment in milliseconds for streaming… hls_fragment_naming Sets the naming scheme for HLS fragment files generated by the NGINX RTMP… hls_fragment_naming_granularity The `hls_fragment_naming_granularity` directive specifies the naming… hls_fragment_slicing The hls_fragment_slicing directive in the NGINX RTMP module enables slicing of… hls_fragments_per_key The `hls_fragments_per_key` directive specifies the number of HLS fragments… hls_key_path The 'hls_key_path' directive specifies the path for the encryption keys used… hls_key_url The `hls_key_url` directive specifies the URL where the encryption key for HLS… hls_keys The `hls_keys` directive configures the HLS playlist to use a specific key for… hls_max_audio_delay The `hls_max_audio_delay` directive sets the maximum allowed audio delay when… hls_max_fragment The `hls_max_fragment` directive sets the maximum duration of each HLS… hls_muxdelay The `hls_muxdelay` directive controls the maximum time to wait before… hls_nested The 'hls_nested' directive enables or disables the HLS nested playlist feature… hls_path The 'hls_path' directive specifies the file path for HLS segments and… hls_playlist_length Sets the maximum length of the HLS playlist for streaming applications in the… hls_sync The `hls_sync` directive configures synchronization settings for HLS output… hls_type The 'hls_type' directive specifies the segment type for HLS (HTTP Live… hls_variant The `hls_variant` directive is used to specify a variant stream for HLS (HTTP… idle_streams The 'idle_streams' directive in the NGINX RTMP module maintains stream… interleave The `interleave` directive enables interleaved RTMP streams for clients that… listen The 'listen' directive in the NGINX RTMP module configures the listening… live The 'live' directive enables live streaming for a specific application in the… log_format The `log_format` directive in the NGINX RTMP module defines the format used… max_connections The `max_connections` directive limits the maximum number of simultaneous… max_message The `max_message` directive limits the maximum size of messages in NGINX RTMP… max_streams The 'max_streams' directive limits the maximum number of concurrent streams… meta The 'meta' directive in the NGINX RTMP module enables adding metadata to the… netcall_buffer The netcall_buffer directive specifies the size of the buffer used for NGINX… netcall_timeout The netcall_timeout directive sets the maximum time to wait for a network call… notify_method The `notify_method` directive configures the callback method for notifications… notify_relay_redirect The `notify_relay_redirect` directive specifies a new destination for all… notify_update_strict The `notify_update_strict` directive in the NGINX RTMP module ensures strict… notify_update_timeout Specifies the timeout duration for notifying clients about updates in the… on_connect The 'on_connect' directive in the NGINX RTMP module allows for specifying a… on_disconnect The `on_disconnect` directive allows specification of actions to be taken when… on_done The 'on_done' directive in the NGINX RTMP module is used to specify a callback… on_play The `on_play` directive in the NGINX RTMP module defines a callback function… on_play_done The `on_play_done` directive specifies a custom HTTP callback endpoint to… on_publish The `on_publish` directive in the NGINX RTMP module allows you to specify a… on_publish_done The `on_publish_done` directive allows you to specify a callback function… on_record_done The `on_record_done` directive allows you to specify a callback function to be… on_update The 'on_update' directive allows defining a callback URL that is triggered… out_cork The 'out_cork' directive controls the output buffering for RTMP streams in the… out_queue The `out_queue` directive in the NGINX RTMP module controls the maximum number… ping The 'ping' directive in the NGINX RTMP module is used to monitor the health of… ping_timeout The `ping_timeout` directive defines the timeout period for detecting inactive… play The `play` directive in the NGINX RTMP module enables playback of audio and… play_local_path The 'play_local_path' directive specifies the local filesystem path for media… play_restart The play_restart directive allows the restarting of video playback from the… play_temp_path The `play_temp_path` directive in the NGINX RTMP module specifies the… play_time_fix The `play_time_fix` directive adjusts the playback duration in the NGINX RTMP… publish_notify The `publish_notify` directive configures notifications to be sent when a new… publish_time_fix The `publish_time_fix` directive adjusts the publication timestamp of the RTMP… pull The "pull" directive allows NGINX to pull a stream from a specified RTMP source. pull_reconnect The pull_reconnect directive specifies whether to enable connection retries… push The `push` directive in the NGINX RTMP module facilitates stream pushing from… push_reconnect The push_reconnect directive configures the automatic reconnection behavior… record The `record` directive in the NGINX RTMP module enables the recording of live… record_append The `record_append` directive controls whether to append to an existing… record_interval The 'record_interval' directive specifies the interval at which stream… record_lock The record_lock directive controls file access for recording streams in the… record_max_frames The `record_max_frames` directive limits the maximum number of frames recorded… record_max_size Sets the maximum size for recorded RTMP streams in the NGINX RTMP module. record_notify The 'record_notify' directive enables server notifications of stream recording… record_path The 'record_path' directive specifies the directory path where recorded… record_suffix The `record_suffix` directive in the NGINX RTMP module specifies a suffix to… record_unique The 'record_unique' directive in the NGINX RTMP module appends a unique… recorder The 'recorder' directive in the NGINX RTMP module is used to configure a block… relay_buffer The relay_buffer directive specifies the buffer size for streamed video data… respawn The 'respawn' directive in NGINX is used to automatically restart streaming… respawn_timeout The 'respawn_timeout' directive in the NGINX RTMP module configures the time… rtmp The 'rtmp' directive enables the RTMP (Real-Time Messaging Protocol) server… main rtmp_auto_push The `rtmp_auto_push` directive enables automatic stream pushing across… main rtmp_auto_push_reconnect The 'rtmp_auto_push_reconnect' directive enables automatic reconnection… main rtmp_control The rtmp_control directive configures control settings for RTMP streams within… httpserverlocation rtmp_socket_dir The `rtmp_socket_dir` directive specifies a directory for storing RTMP socket… main rtmp_stat The 'rtmp_stat' directive generates RTMP streaming statistics in response to… httpserverlocation rtmp_stat_stylesheet The `rtmp_stat_stylesheet` directive sets the URL for an XML stylesheet used… httpserverlocation server The 'server' directive within the NGINX RTMP module defines a server block for… session_relay The 'session_relay' directive is used to enable session relaying for RTMP… so_keepalive The `so_keepalive` directive enables or disables the TCP keepalive feature for… stream_buckets The `stream_buckets` directive configures the number of buckets used for… sync The 'sync' directive controls synchronization of timestamps for segments in a… timeout The `timeout` directive in the NGINX RTMP module defines the maximum duration… wait_key The wait_key directive in the NGINX RTMP module is used to specify the waiting… wait_video The `wait_video` directive in the NGINX RTMP module controls the duration…