MComposerClass Class Methods
MPLATFORMLib Namespace : MComposerClass Class

For a list of all members of this type, see MComposerClass members.

Public Methods
 NameDescription
Public MethodAudioChannelsPerTrackGetGets output number of channels per audio track.  
Public MethodAudioChannelsPerTrackSetSets number of output channels per track.  
Public MethodAudioSplitStringGetGets string mask that separates audio channels into audio tracks.  
Public MethodAudioSplitStringSetSets string mask that separates audio channels into audio tracks. If there is no original tracks information, it is incorrect or you need to separate channels into tracks manually, use this method.  
Public MethodAudioTrackAddAdds a virtual audio track with needed subset of channels. Virtual track clones one of already existsing tracks.  
Public MethodAudioTrackGetByIndexGets the input track by its index.  
Public MethodAudioTrackRemoveRemoves the virtual audio track.  
Public MethodAudioTracksGetCountGets the count of tracks.  
Public MethodAudioTracksSetCountSets number of audio tracks. Use this method to set number of output tracks in playlist before adding files to it.  
Public MethodElementsAddAdds new element. If such element exists then replace it with new one.  
Public MethodElementsGetByIDGets the scene element by its ID.  
Public MethodElementsGetByIndexGets the scene element by its index.  
Public MethodElementsGetCountGets count of scene elements.  
Public MethodElementsMediaAddAdds new element with media. If such element exists then replace it with new one.  
Public MethodFileFrameGetGets the video frame from the specific position of file.  
Public MethodFileFrameGetByTCGets the video frame from the specific position of the file by timecode.  
Public MethodFileInOutGetGet Input and Output time points of file in seconds.
If Out value less than In that means that Out value is not specified and file will be played to the end.  
Public MethodFileInOutGetTCGets the in and out points as timecode.
If Out point is not specified it returns last frame timecode.  
Public MethodFileInOutSetSets the Input and Output time points of a file in seconds  
Public MethodFileInOutSetTCSets the In and Out points as timecode.
If Out point is less then In point then it sets out point as timecode of the clip last frame.  
Public MethodFileNameGetGets the file name, the user properties and the file media information.  
Public MethodFileNameSetAllows you to:
  • Set file name of currently played file.
  • Seamlessly replace currently played file to another one.
  • Set next played file. It will be played after current file is finished.
  • Insert break to file playback: interrupt current file playback, play another file till the end and resume current file playback.
  • Set properties of the file.
 
Public MethodFilePlayPausePauses the playback.  
Public MethodFilePlayStartStarts the file playback.  
Public MethodFilePlayStopStops the file playback for _dblSeconds seconds. To stop file as usual use 0 secods as parameter.  
Public MethodFilePosGetGets the current play position of file in seconds. The position is calculatid from the beginning of file without breaks and in-points.  
Public MethodFilePosGetTCGets the position of file as timecode. The position is calculatid from the beginning of file without breaks and in-points.  
Public MethodFilePosSetSets a position of file in seconds. The position is calculatid from the beginning of file without breaks and in-points.  
Public MethodFilePosSetTCSets the position in file as timecode. The position is calculatid from the beginning of file without breaks and in-points.  
Public MethodFileRateGetGets the playing rate of current file.
Value of rate Description
0..4x Smooth fast forward. All frames are decoded and after this frame rate is corrected.
4x..10x Hopping fast forward. For example, in 10x case there is seeking for each 10th frame.
-10x..0 Hopping back wind. For example, in -4x case there is seeking for each 4th frame in reverse direction of the playback. In this case the rate is rounded to the nearest integer value (e.g. -1.6x equals to -2x).

 
Public MethodFileRateSetSets the playing rate of current file.
Value of rate Description
0..4x Smooth fast forward. All frames are decoded and after this frame rate is corrected.
4x..10x Hopping fast forward. For example, in 10x case there is seeking for each 10th frame.
-10x..0 Hopping back wind. For example, in -4x case there is seeking for each 4th frame in reverse direction of the playback. In this case the rate is rounded to the nearest integer value (e.g. -1.6x equals to -2x).
 
Public MethodFileStateGetGets the current file state.  
Public MethodFormatAudioGetGets the current audio format.  
Public MethodFormatAudioGetByIndexGets the audio format by its index.  
Public MethodFormatAudioGetCountGets the number of audio formats.  
Public MethodFormatAudioSetSets the output audio format for object.  
Public MethodFormatVideoGetGets the current video format.  
Public MethodFormatVideoGetByIndexGets the video format by its index.  
Public MethodFormatVideoGetCountGets the count of video formats.  
Public MethodFormatVideoSetSets the output video format for object.  
Public MethodObjectCallbackSetSets the callback (for C++ and Delphi, for other languages use events). This method blocks the video stream.  
Public MethodObjectCallbackSetFuncSets the callback function (for C++ and Delphi, for other languages use events). The method blocks the video stream.  
Public MethodObjectCloseStops and closes the current object.  
Public MethodObjectCommandExecuteExecutes the special command for object.  
Public MethodObjectFrameGetGets the current frame from any source object.  
Public MethodObjectGetInternalGets DirectShow object in MPlatform. Use for MLive, MRenderer and MWriter objects.  
Public MethodObjectNameGetGets the object name.  
Public MethodObjectNameSetSets the object name.  
Public MethodObjectStartInitializes and starts the object.  
Public MethodObjectStateGetGets the state of object.  
Public MethodObjectVirtualSourceCreateCreates virtual source.  
Public MethodPersistLoadLoads the data from string or from file.  
Public MethodPersistSaveToFileSaves the configuration data to the file.  
Public MethodPersistSaveToStringSaves the configuration data to string.  
Public MethodPluginsAddAdds the plugin (for example, CG).  
Public MethodPluginsAddVB6PluginsAdd method for VB6  
Public MethodPluginsGetByIndexGets the plugin by its index.  
Public MethodPluginsGetByIndexVB6PluginsGetByIndex method for VB6  
Public MethodPluginsGetCountGets the number of plugins.  
Public MethodPluginsRemoveRemoves the plugin.  
Public MethodPluginsReorderReorders plugins (for example, to add CG overlay before color conversion)  
Public MethodPreviewAudioVolumeGetGets the audio volume of preview. "0" is for full loudness and "-100" is for silence.  
Public MethodPreviewAudioVolumeSetSets the audio volume of preview. "0" is for full loudness and "-100" is for silence.  
Public MethodPreviewEnableEnables the preview.  
Public MethodPreviewFullScreenEnables the full screen mode.  
Public MethodPreviewIsEnabledIndicates whether a preview is enabled  
Public MethodPreviewIsFullScreenIndicates whether the full screen mode is enabled on specified screen.  
Public MethodPreviewSetCursorSets type of pointer in video preview window.  
Public MethodPreviewWindowSetSets the parent window for preview.  
Public MethodPreviewWindowSetVB6PreviewWindowSet method for VB6  
Public MethodPropsGetGets the properties.  
Public MethodPropsGetByIndexGets the property by its index.  
Public MethodPropsGetCountGets the count of properties.  
Public MethodPropsInfoGetGets information about property  
Public MethodPropsOptionGetGets property from options  
Public MethodPropsOptionGetByIndexGets property option by its index  
Public MethodPropsOptionGetCountGets number of options for the property  
Public MethodPropsOptionSetByIndexSets option property by its index  
Public MethodPropsRemoveRemoves the property.  
Public MethodPropsSetSets the property.  
Public MethodScenesActiveGetGets the active scene.  
Public MethodScenesActiveSetSets the active scene.  
Public MethodScenesAddAdds a new scene.  
Public MethodScenesElementGetByPosGets element of active scene by its screen position.  
Public MethodScenesGetGets the scene by its ID.  
Public MethodScenesGetByIndexGets the scene by its index.  
Public MethodScenesGetCountGets the count of scenes.  
Public MethodScenesRemoveRemoves the scene.  
Public MethodSourceFrameGetDEPRECATED use SourceFrameGetEx(with reader IDs) !!! Get video frame from source object (MLive, MFile, MPlaylist, MMixer)  
Public MethodSourceFrameGetExGet video frame from source object (MLive, MFile, MPlaylist, MMixer) Note: after stop taken frames, use eFGT_Remove especially for eFGT_Sync mode"  
Public MethodStreamsAddAdds a new mixer stream (file, live or playlist) or replaces the existing one with transition smoothly during the time interval.  
Public MethodStreamsBackgroundGetGets the background of mixer.  
Public MethodStreamsBackgroundSetSets the background for mixer.  
Public MethodStreamsGetGets the stream by its StreamID  
Public MethodStreamsGetByIndexGets the stream by its index.  
Public MethodStreamsGetCountGets the count of miximg streams.  
Public MethodStreamsRemoveRemoves the stream.  
Public MethodStreamsRemoveByIndexRemoves multiple streams.  
Public MethodStreamsReorderChanges the order of streams.  
Top
See Also

Reference

MComposerClass Class
MPLATFORMLib Namespace