From a96990390f081cc193e93ad3c291ab50025be98f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 28 Mar 2024 09:17:29 +0000 Subject: [PATCH] deploy: 1eb95919333308f51ced0811c141a6fd46ab96a0 --- 404.html | 2 +- assets/js/3d0d9de9.26440cf7.js | 1 + assets/js/3d0d9de9.8752d640.js | 1 - ...ime~main.5db53356.js => runtime~main.765556ff.js} | 2 +- docs/api/components/Image.html | 2 +- docs/api/components/InputStream.html | 2 +- docs/api/components/Rescaler.html | 2 +- docs/api/components/Shader.html | 2 +- docs/api/components/Text.html | 2 +- docs/api/components/Tiles.html | 2 +- docs/api/components/View.html | 2 +- docs/api/components/WebView.html | 2 +- docs/api/generated/component-Image.html | 2 +- docs/api/generated/component-InputStream.html | 2 +- docs/api/generated/component-Rescaler.html | 2 +- docs/api/generated/component-Text.html | 2 +- docs/api/generated/component-Tiles.html | 2 +- docs/api/generated/component-View.html | 2 +- docs/api/generated/component-WebView.html | 2 +- docs/api/generated/renderer-Mp4.html | 2 +- docs/api/generated/renderer-OutputStream.html | 2 +- docs/api/generated/renderer-RtpInputStream.html | 2 +- docs/api/generated/renderer-Shader.html | 2 +- docs/api/generated/renderer-WebRenderer.html | 2 +- docs/api/inputs/mp4.html | 2 +- docs/api/inputs/rtp.html | 2 +- docs/api/outputs/rtp.html | 2 +- docs/api/renderers/image.html | 2 +- docs/api/renderers/shader.html | 2 +- docs/api/renderers/web.html | 2 +- docs/api/routes.html | 2 +- docs/category/api-reference.html | 2 +- docs/category/deployment.html | 2 +- docs/common/absolute-position.html | 2 +- docs/concept/component.html | 2 +- docs/concept/layouts.html | 2 +- docs/concept/shaders.html | 2 +- docs/concept/web.html | 2 +- docs/deployment/configuration.html | 12 +++++++++--- docs/get-started.html | 2 +- docs/get-started/elixir.html | 2 +- docs/get-started/node.html | 2 +- docs/intro.html | 2 +- index.html | 2 +- 44 files changed, 51 insertions(+), 45 deletions(-) create mode 100644 assets/js/3d0d9de9.26440cf7.js delete mode 100644 assets/js/3d0d9de9.8752d640.js rename assets/js/{runtime~main.5db53356.js => runtime~main.765556ff.js} (67%) diff --git a/404.html b/404.html index 8f5ff87c7..5e2a67ebd 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@
LIVE_COMPOSITOR_API_PORT
",id:"live_compositor_api_port",level:3},{value:"LIVE_COMPOSITOR_INSTANCE_ID
",id:"live_compositor_instance_id",level:3},{value:"LIVE_COMPOSITOR_OUTPUT_FRAMERATE
",id:"live_compositor_output_framerate",level:3},{value:"LIVE_COMPOSITOR_OUTPUT_SAMPLE_RATE
",id:"live_compositor_output_sample_rate",level:3},{value:"LIVE_COMPOSITOR_FORCE_GPU
",id:"live_compositor_force_gpu",level:3},{value:"LIVE_COMPOSITOR_STREAM_FALLBACK_TIMEOUT_MS
",id:"live_compositor_stream_fallback_timeout_ms",level:3},{value:"LIVE_COMPOSITOR_LOGGER_LEVEL
",id:"live_compositor_logger_level",level:3},{value:"LIVE_COMPOSITOR_LOGGER_FORMAT
",id:"live_compositor_logger_format",level:3},{value:"LIVE_COMPOSITOR_FFMPEG_LOGGER_LEVEL
",id:"live_compositor_ffmpeg_logger_level",level:3},{value:"LIVE_COMPOSITOR_DOWNLOAD_DIR
",id:"live_compositor_download_dir",level:3},{value:"LIVE_COMPOSITOR_WEB_RENDERER_ENABLE
",id:"live_compositor_web_renderer_enable",level:3},{value:"LIVE_COMPOSITOR_WEB_RENDERER_GPU_ENABLE
",id:"live_compositor_web_renderer_gpu_enable",level:3},{value:"LIVE_COMPOSITOR_OFFLINE_PROCESSING_ENABLE
",id:"live_compositor_offline_processing_enable",level:3},{value:"LIVE_COMPOSITOR_AHEAD_OF_TIME_PROCESSING_ENABLE
",id:"live_compositor_ahead_of_time_processing_enable",level:3},{value:"LIVE_COMPOSITOR_NEVER_DROP_OUTPUT_FRAMES
",id:"live_compositor_never_drop_output_frames",level:3},{value:"LIVE_COMPOSITOR_RUN_LATE_SCHEDULED_EVENTS
",id:"live_compositor_run_late_scheduled_events",level:3}];function a(e){const o={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(o.h2,{id:"environment-variables",children:"Environment variables"}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_api_port",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_API_PORT"})}),"\n",(0,n.jsx)(o.p,{children:"API port. Defaults to 8081."}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_instance_id",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_INSTANCE_ID"})}),"\n",(0,n.jsxs)(o.p,{children:["ID that will be returned in ",(0,n.jsx)(o.code,{children:"GET /status"})," request. Can be used to identify if we are connecting to the correct compositor instance."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_output_framerate",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_OUTPUT_FRAMERATE"})}),"\n",(0,n.jsxs)(o.p,{children:["Output framerate for all output streams. This value can be a number or string in the ",(0,n.jsx)(o.code,{children:"NUM/DEN"})," format, where both ",(0,n.jsx)(o.code,{children:"NUM"})," and ",(0,n.jsx)(o.code,{children:"DEN"})," are unsigned integers. Defaults to ",(0,n.jsx)(o.code,{children:"30"})]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_output_sample_rate",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_OUTPUT_SAMPLE_RATE"})}),"\n",(0,n.jsx)(o.p,{children:"Output sample rate for all output streams. This value has to be a number or string representing supported sample rate. Defaults to 48000."}),"\n",(0,n.jsx)(o.p,{children:"Supported sample rates are: 8000, 12000, 16000, 24000, 48000"}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_force_gpu",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_FORCE_GPU"})}),"\n",(0,n.jsxs)(o.p,{children:["If enabled, GPU will be required for rendering. If only CPU based adapters will be found then process will exit with an error. Defaults to ",(0,n.jsx)(o.code,{children:"false"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_stream_fallback_timeout_ms",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_STREAM_FALLBACK_TIMEOUT_MS"})}),"\n",(0,n.jsx)(o.p,{children:"A timeout that defines when the compositor should switch to fallback on the input stream that stopped sending frames. Defaults to 500."}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_logger_level",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_LOGGER_LEVEL"})}),"\n",(0,n.jsxs)(o.p,{children:["Logger level. Value can be defined as ",(0,n.jsx)(o.code,{children:"error"}),"/",(0,n.jsx)(o.code,{children:"warn"}),"/",(0,n.jsx)(o.code,{children:"info"}),"/",(0,n.jsx)(o.code,{children:"debug"}),"/",(0,n.jsx)(o.code,{children:"trace"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["This value also supports syntax for more detailed configuration. See ",(0,n.jsxs)(o.a,{href:"https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax",children:[(0,n.jsx)(o.code,{children:"tracing-subscriber"})," crate documentation"]})," for more info."]}),"\n",(0,n.jsxs)(o.p,{children:["Defaults to ",(0,n.jsx)(o.code,{children:"info,wgpu_hal=warn,wgpu_core=warn"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_logger_format",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_LOGGER_FORMAT"})}),"\n",(0,n.jsx)(o.p,{children:"Logger format. Supported options:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"json"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"compact"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"pretty"})}),"\n"]}),"\n",(0,n.jsx)(o.admonition,{type:"warning",children:(0,n.jsxs)(o.p,{children:["This option does not apply to logs produced by ",(0,n.jsx)(o.code,{children:"FFmpeg"})," or the embedded Chromium instance used for web rendering. Defaults to ",(0,n.jsx)(o.code,{children:"json"}),"."]})}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_ffmpeg_logger_level",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_FFMPEG_LOGGER_LEVEL"})}),"\n",(0,n.jsx)(o.p,{children:"Minimal log level that should be logged. Supported options:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"error"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"error, 16"})]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"warn"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"warning, 24"})]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"info"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"info, 32"})]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"debug"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"debug, 48"})]}),"\n"]}),"\n",(0,n.jsxs)(o.p,{children:["See ",(0,n.jsx)(o.code,{children:"-loglevel"})," option in ",(0,n.jsx)(o.a,{href:"https://ffmpeg.org/ffmpeg.html",children:"FFmpeg documentation"}),". Defaults to ",(0,n.jsx)(o.code,{children:"warn"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_download_dir",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_DOWNLOAD_DIR"})}),"\n",(0,n.jsx)(o.p,{children:"A path to a directory in which downloaded files will be stored. Uses the location provided by the OS if not set."}),"\n",(0,n.jsxs)(o.p,{children:["In this directory, an instance of the compositor will create a subdirectory named ",(0,n.jsx)(o.code,{children:"live-compositor-LIVE_COMPOSITOR_API_PORT
",id:"live_compositor_api_port",level:3},{value:"LIVE_COMPOSITOR_INSTANCE_ID
",id:"live_compositor_instance_id",level:3},{value:"LIVE_COMPOSITOR_OUTPUT_FRAMERATE
",id:"live_compositor_output_framerate",level:3},{value:"LIVE_COMPOSITOR_OUTPUT_SAMPLE_RATE
",id:"live_compositor_output_sample_rate",level:3},{value:"LIVE_COMPOSITOR_FORCE_GPU
",id:"live_compositor_force_gpu",level:3},{value:"LIVE_COMPOSITOR_STREAM_FALLBACK_TIMEOUT_MS
",id:"live_compositor_stream_fallback_timeout_ms",level:3},{value:"LIVE_COMPOSITOR_LOGGER_LEVEL
",id:"live_compositor_logger_level",level:3},{value:"LIVE_COMPOSITOR_LOGGER_FORMAT
",id:"live_compositor_logger_format",level:3},{value:"LIVE_COMPOSITOR_FFMPEG_LOGGER_LEVEL
",id:"live_compositor_ffmpeg_logger_level",level:3},{value:"LIVE_COMPOSITOR_DOWNLOAD_DIR
",id:"live_compositor_download_dir",level:3},{value:"LIVE_COMPOSITOR_WEB_RENDERER_ENABLE
",id:"live_compositor_web_renderer_enable",level:3},{value:"LIVE_COMPOSITOR_WEB_RENDERER_GPU_ENABLE
",id:"live_compositor_web_renderer_gpu_enable",level:3},{value:"LIVE_COMPOSITOR_AHEAD_OF_TIME_PROCESSING_ENABLE
",id:"live_compositor_ahead_of_time_processing_enable",level:3},{value:"LIVE_COMPOSITOR_RUN_LATE_SCHEDULED_EVENTS
",id:"live_compositor_run_late_scheduled_events",level:3}];function a(e){const o={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(o.h2,{id:"environment-variables",children:"Environment variables"}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_api_port",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_API_PORT"})}),"\n",(0,n.jsx)(o.p,{children:"API port. Defaults to 8081."}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_instance_id",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_INSTANCE_ID"})}),"\n",(0,n.jsxs)(o.p,{children:["ID that will be returned in ",(0,n.jsx)(o.code,{children:"GET /status"})," request. Can be used to identify if we are connecting to the correct compositor instance."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_output_framerate",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_OUTPUT_FRAMERATE"})}),"\n",(0,n.jsxs)(o.p,{children:["Output framerate for all output streams. This value can be a number or string in the ",(0,n.jsx)(o.code,{children:"NUM/DEN"})," format, where both ",(0,n.jsx)(o.code,{children:"NUM"})," and ",(0,n.jsx)(o.code,{children:"DEN"})," are unsigned integers. Defaults to ",(0,n.jsx)(o.code,{children:"30"})]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_output_sample_rate",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_OUTPUT_SAMPLE_RATE"})}),"\n",(0,n.jsx)(o.p,{children:"Output sample rate for all output streams. This value has to be a number or string representing supported sample rate. Defaults to 48000."}),"\n",(0,n.jsx)(o.p,{children:"Supported sample rates are: 8000, 12000, 16000, 24000, 48000"}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_force_gpu",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_FORCE_GPU"})}),"\n",(0,n.jsxs)(o.p,{children:["If enabled, GPU will be required for rendering. If only CPU based adapters will be found then process will exit with an error. Defaults to ",(0,n.jsx)(o.code,{children:"false"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_stream_fallback_timeout_ms",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_STREAM_FALLBACK_TIMEOUT_MS"})}),"\n",(0,n.jsx)(o.p,{children:"A timeout that defines when the compositor should switch to fallback on the input stream that stopped sending frames. Defaults to 500."}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_logger_level",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_LOGGER_LEVEL"})}),"\n",(0,n.jsxs)(o.p,{children:["Logger level. Value can be defined as ",(0,n.jsx)(o.code,{children:"error"}),"/",(0,n.jsx)(o.code,{children:"warn"}),"/",(0,n.jsx)(o.code,{children:"info"}),"/",(0,n.jsx)(o.code,{children:"debug"}),"/",(0,n.jsx)(o.code,{children:"trace"}),"."]}),"\n",(0,n.jsxs)(o.p,{children:["This value also supports syntax for more detailed configuration. See ",(0,n.jsxs)(o.a,{href:"https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax",children:[(0,n.jsx)(o.code,{children:"tracing-subscriber"})," crate documentation"]})," for more info."]}),"\n",(0,n.jsxs)(o.p,{children:["Defaults to ",(0,n.jsx)(o.code,{children:"info,wgpu_hal=warn,wgpu_core=warn"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_logger_format",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_LOGGER_FORMAT"})}),"\n",(0,n.jsx)(o.p,{children:"Logger format. Supported options:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"json"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"compact"})}),"\n",(0,n.jsx)(o.li,{children:(0,n.jsx)(o.code,{children:"pretty"})}),"\n"]}),"\n",(0,n.jsx)(o.admonition,{type:"warning",children:(0,n.jsxs)(o.p,{children:["This option does not apply to logs produced by ",(0,n.jsx)(o.code,{children:"FFmpeg"})," or the embedded Chromium instance used for web rendering. Defaults to ",(0,n.jsx)(o.code,{children:"json"}),"."]})}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_ffmpeg_logger_level",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_FFMPEG_LOGGER_LEVEL"})}),"\n",(0,n.jsx)(o.p,{children:"Minimal log level that should be logged. Supported options:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"error"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"error, 16"})]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"warn"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"warning, 24"})]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"info"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"info, 32"})]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.code,{children:"debug"})," - equivalent to FFmpeg's ",(0,n.jsx)(o.code,{children:"debug, 48"})]}),"\n"]}),"\n",(0,n.jsxs)(o.p,{children:["See ",(0,n.jsx)(o.code,{children:"-loglevel"})," option in ",(0,n.jsx)(o.a,{href:"https://ffmpeg.org/ffmpeg.html",children:"FFmpeg documentation"}),". Defaults to ",(0,n.jsx)(o.code,{children:"warn"}),"."]}),"\n",(0,n.jsx)(o.h3,{id:"live_compositor_download_dir",children:(0,n.jsx)(o.code,{children:"LIVE_COMPOSITOR_DOWNLOAD_DIR"})}),"\n",(0,n.jsx)(o.p,{children:"A path to a directory in which downloaded files will be stored. Uses the location provided by the OS if not set."}),"\n",(0,n.jsxs)(o.p,{children:["In this directory, an instance of the compositor will create a subdirectory named ",(0,n.jsx)(o.code,{children:"live-compositor-LIVE_COMPOSITOR_WEB_RENDERER_GPU_ENABLE
Enable GPU support inside the embedded Chromium instance.
Defaults to true
. Valid values: true
, false
, 1
, 0
.
LIVE_COMPOSITOR_OFFLINE_PROCESSING_ENABLE
If enabled, sets LIVE_COMPOSITOR_AHEAD_OF_TIME_PROCESSING_ENABLE
and LIVE_COMPOSITOR_NEVER_DROP_OUTPUT_FRAMES
options to true
. If those values are also defined then they take priority over this value.
Defaults to false
. Valid values: true
, false
, 1
, 0
.
LIVE_COMPOSITOR_AHEAD_OF_TIME_PROCESSING_ENABLE
If enabled, the LiveCompositor server will try to generate output frames ahead of time if all inputs are available.
+If enabled, the LiveCompositor server will try to generate output frames/samples ahead of time if all inputs are available.
When to enable this option:
Defaults to false
. Valid values: true
, false
, 1
, 0
.
LIVE_COMPOSITOR_NEVER_DROP_OUTPUT_FRAMES
If enabled, the LiveCompositor server will not drop frames/samples from output stream even if rendering or encoding is not fast enough to process it in real time.
+Defaults to false
. Valid values: true
, false
, 1
, 0
.
LIVE_COMPOSITOR_RUN_LATE_SCHEDULED_EVENTS
Parts of the compositor API support a schedule_time_ms
field to apply certain actions at a specific time. If enabled, the event will still be executed, even if it was scheduled too late. Otherwise, it will be discarded.
Defaults to false
. Valid values: true
, false
, 1
, 0
.
Defaults to false
. Valid values: true
, false
, 1
, 0
.