The properties are stored in the system registry:
[HKEY_CURRENT_USER\SOFTWARE\Medialooks\MPlatform\MPreview]
and can be set with the PropsSet method. Please refer to this article about prefixes for properties.
| Name | Default value | Description |
|---|---|---|
| audio.buffer_size_msec | 100 | Sets a buffer size for audio data in msec. |
| audio.direct_sound | false | Enables direct sound mode. |
| audio_channels | Default audio channels configuration. | |
| audio_gain | Default audio gain configuration. | |
| audio_play.device_buffer_duration | 0 | Audio preview buffer size in seconds. Playback starts only after 3/4 of this buffer is filled. Larger values increase the startup delay and memory usage. |
| audio_renderer | Sets the audio renderer that is used for preview. The empty string means the default audio device. | |
| debug.test_tone | Sets a test tone in Hz. Debug-only property. | |
| deinterlace | true | Enables deinterlacing mode. |
| direct3d.pixel_format | auto | Sets pixel format for Direct3D-based preview. |
| direct3d.scale_backbuffer | true | Enables scaling for a back buffer for Direct3D-based preview. |
| direct3d.scale_filter | 2 | Sets scale filter for Direct3D-based preview. |
| dx11.field_only | For DX11 mode only. Preview a single field only. | |
| dx11.swap_chain_latency_wait | true | Sets DX11 preview to wait until the swap operation is complete. |
| dx11.swap_chain_resize | true | For DX11 mode only. Swap DirectX chain on preview resize. |
| dx11.swap_chain_scale | 1.5 | Sets DX11 preview scaling quality. |
| dx11.use_vsync | false | Enables VSync use for DX11 preview. |
| dx11.windowless | false | Use preview in a windowless mode. |
| dx9.windowless | false | Use preview in a windowless mode. |
| 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_preview.height | 549 | Initial height of external preview (in pixels) |
| external_preview.width | 720 | Initial width of external preview (in pixels) |
| external_preview.x | 64 | Initial X-coordinate of the external preview (in pixels) |
| external_preview.y | 64 | Initial Y-coordinate of the external preview (in pixels) |
| gpu.rgb_transform_matrix | Default color transformation matrix for the GPU mode. | |
| maintain_ar | true | Makes MPreview object to maintain source aspect ratio. If disabled, the preview video stretches to the control size. |
| object_name | MPreview |
Default name of the object. If you need to change it, use the following approach:
m_objPreview.ObjectNameSet("new_name"); Note, that it's possible to change the name only before the object is started. If the object is running, stop it, and only then rename the object. |
| on_event.sync | false | Makes OnEvent and OnEventSafe 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_frame.sync | false | Makes OnFrame and OnFrameSafe events synchronous, so frame grabbing process won't continue until OnFrame event isn't over. |
| overlay_rms | false | Enables RMS overlay. |
| overlay_rms.color | green |
Specifies default RMS overlay color. Possible values:
|
| overlay_rms.color_error | 0xFFA20F0F | The color of the RMS bars when the volume level is above -7 dB. |
| overlay_rms.color_nominal | 0xFF00A000 | The color of the RMS bars when the volume level is below -20 dB. |
| overlay_rms.color_warning | 0xFFB4B40D | The color of the RMS bars when the volume level is above -20 dB but below -7 dB. |
| overlay_rms.level_check | false | Makes the overlay RMS bars three-color depending on the volume level. |
| overlay_rms.pos | 0.05 | Specifies the relative vertical position of the RMS overlay. Available values are from 0.00 to 1.00. |
|
overlay_rms.vertical |
false | Makes the RMS overlay bars vertical. |
| overlay_waveform | false | Enables waveform overlay. |
| overlay_waveform.color | Specifies the waveform overlay color. | |
| overlay_waveform.pos | 0.3 | Specifies the waveform overlay position relative to the center. |
| preview.alpha_channel | gpu |
Add a possibility to use alpha channel. Content with transparency is displayed with a checkerboard background on a preview. Possible values:
|
| preview.background | checker |
Sets default background for preview.
|
| preview.buffers | 1 | Sets a buffer size of frames. |
| preview.crop | 0.0%,0.0%,0.0%,0.0% | Default preview crop configuration. |
| preview.downscale | dword:00000001 |
Downscales preview video to optimize performance.
|
| preview.drop_frames | false | Once enabled, an MPreview object can drop frames in case frame processing takes a long time. |
| preview.external_process | false | Makes preview to work in an external MServer.exe process |
| preview.fullscreen.close_on_click | false | Enables closing fullscreen preview on mouse click. When disabled, fullscreen preview does not close on click (default behavior). Useful in WPF, where mouse click events on external preview windows cannot be intercepted. |
| preview.gpu_cc | true | Enables pixel format conversion on the GPU |
| preview.skip_fields | 0 |
Sets a mode for skipping fields (for interlaced video only).
it is not only for the interlaced video. For progressive, it skips full frames (counts as 2). For 30p input, the skip_fields = 15 gives you the resulting fps at about 4 (3.8), and if you set skip_fields to 30, it results in 2 fps. |
| preview.title | MFPreview | Changes the title of the window if the preview is opened in windowed mode or full-screen mode |
| preview.type | dx11 |
Type of preview.
|
| pull_mode | false | Enables pull-mode for preview |
| rate_control | false | Makes the MPreview object to control the playback rate |
| register_object | true | Once enabled, the MPreview object is registered to the system to gather statistics. |
| statistics.extended | stat | Sets a prefix for gathering statistics of an MPreview object after all the conversion and changes. |
| video_renderer | Sets video renderer that is used for preview. The empty string means the default video device. | |
| wpf_preview | false | Enables WPF preview. See more for details. |
| wpf_preview.cpu_dx11 | false | Forces DX11 preview in CPU mode. |
| wpf_preview.downscale | dword:00000000 | Sets downscale parameter for WPF preview. See more for details. |
| wpf_preview.sync_texture | false | Synchronizes D3DTexture objects in case of multiple preview instances are used. |
| wpf_preview.update | dword:0000001e | Sets update period for WPF preview. See more for details. |