Top

Articles in this section

MPlaylist object properties

Avatar
Alexander Bashlykov
  • Updated

The properties are stored in the system registry:

[HKEY_CURRENT_USER\SOFTWARE\Medialooks\MPlatform\MPlaylist]

and can be set with the PropsSet method. Please refer to this article about prefixes for properties.

Name Default value Description
imaudio.enabled true Enables IMAudio interface for the object. 
audio_channels   Default audio channels configuration.
audio_gain   Default audio gain configuration. 
gpu.rgb_transform_matrix   The default color transformation matrix for the GPU mode.
statistics.extended stat Sets a prefix for gathering statistics of an MPlaylist object after all the conversion and changes.
active_frc dword:00000001 Sets active frame rate converter mode. 
on_frame.sync false Makes OnFrame and OnFrameSafe events synchronous, so frame grabbing process won't continue until OnFrame event isn't over.
on_frame.data false Enables objects of OnFrame and OnFrameSafe events to contain MFrame data.
on_event.sync false Makes OnEvent and OnEventSafe events synchronous, so frame grabbing process won't continue until the OnEvent event isn't over.
events.use_window true Use events (OnFrame, OnEvent, OnEventSafe, and OnFrameSafe) in the thread of your application. If you use a service or an application without windows, then disable this mode.
external_access true Once enabled, you can use MPlaylist objects in external applications through mp:// links and IMSenders.
default_name MPlaylist Default name of the object. Call ObjectNameSet method before you start the object to change the name from code.
preview.type dx9 Type of preview.
Possible values:
  • "dshow" - uses DirectShow-based preview
  • "direct3d" - uses DirectX-based preview. Requires DirectX to be installed on a system.
preview.show_cc true  
deinterlace true Enables deinterlacing mode.
preview.drop_frames false Enables a mode in which frames can be dropped by preview object.
preview.crop 0.0%,0.0%,0.0%,0.0% Default crop configuration for preview only.
preview.audio_channels   Default audio channels configuration for preview.
preview.pull false Enables pull-mode for preview.
default_tracks dword:00000001 Default amount of audio tracks.
default_channels dword:00000000 Default amount of audio channels (0 means use original)
channels_per_track dword:00000000 Default amount of channels per track.
pause.fields dword:00000002 Sets a mode for pause.
Possible values:
  • 0 - pause on top-field only
  • 1 - pause on bottom-field only
  • 2 - pause on each field
pause.use_reference false Sets usage of a reference frame to be used on pause
pause.mute_audio false Once "true", there is no audio when a playlist is paused and you display it frame by frame.
internal.convert_frame false Enables possibility to convert frames internally before the object is used in MPlaylist or MMixer (if disabled, it converts video to a format of the top object, e.g. MMixer).
reverse.init_next true Initializes the next item at reverse playback for smooth switching.
playlist.init_next dword:00000001 Specifies mode of initialization of next items.
Possible values:
  • 0 - do not initialize next items (leads to lower CPU usage, but for heavy files, there could be a delay the moment of switching)
  • 1 - initialize the next item only (slightly higher CPU usage, but switching between playlist items is smooth in case of simple playback, but seeking to different items can lead to drops)
  • 2 - initialize all the items in a playlist (high CPU usage but smooth switching to any playlist items).
playlist.eol_rewind true Once enabled, playlist rewinds to the beginning when it is over.
plugins.optimization true Enables extra optimization for plugins.
playlist.override_timecode false Once enabled, overrides timecode of playlist items with its own timecode (specified with "playlist.start_timecode" property).
playlist.start_timecode 00:00:00:00 Sets start timecode of a playlist. Works only if "playlist.override_timecode" is enabled.
file.check_at_add true Once enabled, MPlaylist checks file properties the moment you add it to the playlist.
dynamic false Enables dynamic playlist mode. In this mode, a playlist item, once over, is removed from the playlist.
playlist.on_next   Specifies behavior of a playlist on switching to the next item.
Possible values:
  • "stop" - stop after each file;
  • "pause_in" - pause after each file on the first frame of the next item;
  • "pause_out" - pause after each file on the last frame of the current item;
  • "" - default behavior (continue playback).
loop true Sets playlist in loop mode.
background_rewind false Sets background behavior. When playback is stopped the background is resumed from the start ("true") of from the last background frame ("false").
background_transition true Enables a possibility to use transitions for backgrounds.
setpos_transition false Once enabled, you can switch between playlist items using the PlaylistPosSet method with transitions (transitions specified for playlist items separately).
background colorbars-ntsc Sets default background.
Possible values:
  • a path to a local file (still image or a video)
  • hex code of a color
schedule_waitstart stop Specifies behavior of a playlist for scheduled items.
Possible values:
  • "stop" - then playlist is stopped and the background is displayed shown until the scheduled time.
  • "pause-in" - then playlist is paused on the first frame of next file until the scheduled time.
  • "pause-out" - then playlist is paused on the last frame of the previous file until the scheduled time.
  • "skip" - then the next file with specified start time is skipped and the next available file without specified start time is played. If there are no files without specified start time in the whole playlist then playlist is stopped.
scaling_quality auto Sets scaling quality for video.
Possible values:
  • auto - automatically detects the best suitable quality
  • 2 - poor scaling but low CPU usage
  • 8 - good scaling and average CPU usage
  • 18 - best scaling and high CPU usage
overlay_timecode false Overlays video with timecode. Debug property.
overlay_rms false Enables RMS overlay.
overlay_rms.pos 0.1 Specifies the relative vertical position of the RMS overlay. Available values are from 0.00 to 1.00.
overlay_rms.color green

Specifies RMS overlay color.

Possible values:

  • color - blue - text
  • color(255) - blue(128) - text + (alpha)
  • [#]RGB - #0000FF - hex ("#" - optional)
  • [#]ARGB - #ff0000ff - hex ("#" - optional)
overlay_waveform false Enables waveform overlay.
overlay_waveform.pos 0.3 Specifies the waveform overlay position relative to the center.
overlay_waveform.color   Specifies the waveform overlay color.
pull_mode.cycles_before_disconnect dword:0000000a Sets number of cycles before preview is disconnected.
pull_mode.wait_till_get dword:000000c8 Sets duration in msec for a preview to wait till it gets a frame.
audio.variable_rate true Once enabled, the audio is adapted to playback rate (e.g. if you play a video at 0.5 speed the audio is also sloooow). Once disabled, audio is played at normal speed (e.g. if you play a video at 0.5 speed, the audio sounds like chunks).sloooow). Once disabled, audio is played at normal speed (e.g. if you play a video at 0.5 speed, the audio sounds like chunks).
audio.lufs false Enables LUFS audio measurement
audio.lufs_state   Sets LUFS measurement state. Possible values:"" (continue the calculation), "reset", "pause"
audio.lufs_channels   Sets the channels for LUFS measurements
audio.gain_normalization false Enables audio gain normalization
gain_normalization.target_i -23.0 Target gain level for audio normalization.
gain_normalization.gating -100.0 The gating parameter for audio normalization
gain_normalization.loudness_type rms Type of audio normalization. Possible values: "rms", "m", "s", "i"
timecode.time_sync dword:00000000

Possible values:
0 - disable time sync

1- uses an original timecode (even if it is overridden);
2 - uses a local machine time (is set just once and increases timecode on each next frame);
3 - uses a local machine time (is set and is updated periodically to keep synchronization)
timecode.offset   Sets an offset to a timecode, e.g. "o1:23:45:21"
mfconverter.enabled true enables internal conversion mechanism (not recommended to change)
format.set_default_pixelformat true use the original pixel format for video conversion
experimental.exact_duration false Once enabled, the MPlaylist plays files as if you set 'out' points equal the 'duration'.
Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles