Difference between revisions of "Documentation:Modules/fake"

From VideoLAN Wiki
Jump to navigation Jump to search
m (+sc × 2)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Module|name=fake|type=Access Demux|last_version=0.9.0|description=simulate a fake input}}
+
__NOTOC__
{{Module|name=fake|type=Codec|last_version=0.9.0|description=handle a fake input stream}}
 
 
 
 
== Options ==
 
== Options ==
 
=== Access Demux ===
 
=== Access Demux ===
 +
{{Module|name=fake|type=Access demux|last_version=0.9.0|description=simulate a fake input|sc=fake}}
 
{{Option
 
{{Option
 
|name=fake-caching
 
|name=fake-caching
 
|value=integer
 
|value=integer
|description=Caching in ms
+
|default=<code><var>DEFAULT_PTS_DELAY</var>/1000</code>
 +
|description=Caching in [[wiktionary:ms|milliseconds]]
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=fake-fps
 
|name=fake-fps
 
|value=float
 
|value=float
|default=25.
+
|default=25.0
|description=Framerate
+
|description=[[Framerate]] e.g. 24, 25, 29.97, 30
 
}}
 
}}
 
{{Option
 
{{Option
Line 19: Line 19:
 
|value=integer
 
|value=integer
 
|default=0
 
|default=0
|description=Elementary stream ID
+
|description=Set the ID of the fake [[elementary stream]] for use in <samp>#{{docmod|duplicate}}{}</samp> constructs
 
}}
 
}}
 
{{Option
 
{{Option
Line 25: Line 25:
 
|value=integer
 
|value=integer
 
|default=0
 
|default=0
|description=Duration in ms if non zero
+
|description=Duration of the fake streaming (in milliseconds) before faking an end-of-file (default is 0, meaning that the stream is unlimited)
 
}}
 
}}
 +
{{Clear|right}}
  
 
=== Codec ===
 
=== Codec ===
 +
{{Module|name=fake|type=Codec|last_version=0.9.0|description=handle a fake input stream|sc=fake}}
 
{{Option
 
{{Option
 
|name=fake-file
 
|name=fake-file
Line 55: Line 57:
 
{{Option
 
{{Option
 
|name=fake-keep-ar
 
|name=fake-keep-ar
 +
|value=boolean
 
|default=disabled
 
|default=disabled
|description=Keep aspect ratio when resizing
+
|description=Keep [[aspect ratio]] when resizing
 
}}
 
}}
 
{{Option
 
{{Option
Line 62: Line 65:
 
|value=string
 
|value=string
 
|default=""
 
|default=""
|description=Aspect ratio (FIXME: pixels?image?)
+
|description=Aspect ratio of the image file (4:3, 16:9). Default is square pixels
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=fake-deinterlace
 
|name=fake-deinterlace
 +
|value=boolean
 
|default=disabled
 
|default=disabled
|description=Deinterlace the image after loading it
+
|description=[[Deinterlace]] the image after loading it
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=fake-deinterlace-module
 
|name=fake-deinterlace-module
 
|value=string
 
|value=string
|default=""
+
|default="deinterlace"
 
|description=Deinterlace module
 
|description=Deinterlace module
 
}}
 
}}
Line 78: Line 82:
 
|name=fake-chroma
 
|name=fake-chroma
 
|value=string
 
|value=string
|default="I420"
+
|default="[[I420]]"
|description=Image chroma
+
|description=Image [[chroma]]
 
}}
 
}}
  
 
== Example ==
 
== Example ==
  % '''vlc fake:// --fake-file someimage.png'''
+
  {{$}} '''vlc fake:// --fake-file someimage.png'''
  
{{Stub}}
+
== Source code ==
 +
* {{VLCSourceFile|modules/access/fake.c|p=vlc/vlc-0.9.git}}
 +
* {{VLCSourceFile|modules/codec/fake.c|p=vlc/vlc-0.9.git}}
  
{{Documentation}}
+
{{Documentation footer}}

Latest revision as of 08:51, 31 May 2019

Options

Access Demux

Module: fake
Type Access demux
First VLC version -
Last VLC version 0.9.0
Operating system(s) all
Description simulate a fake input
Shortcut(s) fake
  • fake-caching <integer> : Caching in milliseconds default value: DEFAULT_PTS_DELAY/1000
  • fake-fps <float> : Framerate e.g. 24, 25, 29.97, 30 default value: 25.0
  • fake-id <integer> : Set the ID of the fake elementary stream for use in #duplicate{} constructs default value: 0
  • fake-duration <integer> : Duration of the fake streaming (in milliseconds) before faking an end-of-file (default is 0, meaning that the stream is unlimited) default value: 0

Codec

Module: fake
Type Codec
First VLC version -
Last VLC version 0.9.0
Operating system(s) all
Description handle a fake input stream
Shortcut(s) fake
  • fake-file <string> : Image to use as video for the fake stream default value: ""
  • fake-file-reload <integer> : Number of seconds between each reload of the image default value: 0
  • fake-width <integer> : Width default value: 0
  • fake-height <integer> : Height default value: 0
  • fake-keep-ar <boolean> : Keep aspect ratio when resizing default value: disabled
  • fake-aspect-ratio <string> : Aspect ratio of the image file (4:3, 16:9). Default is square pixels default value: ""
  • fake-deinterlace <boolean> : Deinterlace the image after loading it default value: disabled
  • fake-deinterlace-module <string> : Deinterlace module default value: "deinterlace"
  • fake-chroma <string> : Image chroma default value: "I420"

Example

$ vlc fake:// --fake-file someimage.png

Source code

This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.