MItemClass Class Methods
MPLATFORMLib Namespace : MItemClass Class

For a list of all members of this type, see MItemClass 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 MethodBreaksAddAdds a new break to specific time of a playlist, file or live source.  
Public MethodBreaksCommandAddAdds a new break command to specific time of playlist, file or live source.  
Public MethodBreaksGetByIndexGets the break by its index.  
Public MethodBreaksGetCountGets the number of breaks in file, playlist or live source and total breaks duration.  
Public MethodBreaksRemoveRemoves the break.  
Public MethodBreaksRemoveByIndexRemoves break by its index.
This method also allows to remove number of breaks by a single call.  
Public MethodBreaksTimeSetChanges the break time for specific break.  
Public MethodDeckAbortAborts the deck.  
Public MethodDeckCloseOptionally place the deck in standby mode before closing the connection  
Public MethodDeckCrashRecordStartSets the deck to record.  
Public MethodDeckCrashRecordStopStops the deck record operation.  
Public MethodDeckEjectSends an “eject tape” command to the deck.  
Public MethodDeckFastForwardSends a “fast forward” command to the deck.  
Public MethodDeckGetCaptureOffsetReturns the current setting of the field accurate capture timecode offset in fields.  
Public MethodDeckGetCurrentStateGets the current state of the deck  
Public MethodDeckGetDeviceIDGets the device ID returned by the deck.  
Public MethodDeckGetExportOffsetReturns the current setting of the export offset in fields.  
Public MethodDeckGetManualExportOffsetReturns the manual export offset for the current deck. This is only applicable for manual exports and may be adjusted with the main export offset if required.  
Public MethodDeckGetPrerollGets the preroll time period.  
Public MethodDeckGetTimecodeReturns the current timecode.  
Public MethodDeckGetTimecodeStringReturns the current timecode in string format.  
Public MethodDeckGoToTimecodeSends a “go to timecode” command to the deck.  
Public MethodDeckJogSends a “jog playback” command to the deck.  
Public MethodDeckOpenConfigures a deck control session and opens a connection to a deck.  
Public MethodDeckPlaySends a “play” command to the deck.  
Public MethodDeckRewindSends a “rewind” command to the deck.  
Public MethodDeckSendCommandSends a custom command to the deck. A custom command operation cannot occur if there is an export-to-tape, capture or a custom command operation in progress. The supplied custom command must conform to the Sony 9 Pin protocol and must not include the checksum byte. It will be generated by this interface and added to the command.  
Public MethodDeckSendCommand_ISends a custom command to the deck. A custom command operation cannot occur if there is an export-to-tape, capture or a custom command operation in progress. The supplied custom command must conform to the Sony 9 Pin protocol and must not include the checksum byte. It will be generated by this interface and added to the command.  
Public MethodDeckSetCaptureOffsetThe capture offset may be used to compensate for a deck specific offset between the inpoint and the time at which the capture starts.  
Public MethodDeckSetExportOffsetSets the current export timecode offset in fields. This method permits fine control of the timecode offset to tailor for the response of an individual deck by adjusting the number of fields prior to the in or out point where an export will begin or end.  
Public MethodDeckSetPrerollSets the preroll time period.  
Public MethodDeckSetStandbySends a “set standby” command to the deck  
Public MethodDeckShuttleSends a “shuttle” playback command to the deck.  
Public MethodDeckStartCaptureStarts a capture operation using the given parameters.  
Public MethodDeckStartExportStarts an export to tape operation using the given parameters.  
Public MethodDeckStepBackSends a “step back” command to the deck.  
Public MethodDeckStepForwardSends a “step forward” command to the deck.  
Public MethodDeckStopSends a “stop” command to the deck  
Public MethodDeckTogglePlayStopSends a “play” command to the deck, if the deck is currently paused or stopped. If the deck is currently playing, a “pause” command will be sent to the deck.  
Public MethodDeviceGetGets the current device and its properties.  
Public MethodDeviceGetByIndexGets the device name or device properties by its index.  
Public MethodDeviceGetCountGet the devices or properties count.  
Public MethodDeviceSetSets the working device or updates device properties.  
Public MethodDeviceShowPropsShows the device properties.  
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 MethodItemCommandExecuteExecutes the command.  
Public MethodItemCommandGetGets the command properties (only for command).  
Public MethodItemCommandSetSets the command properties (only for command).  
Public MethodItemInnerGetGets the inner object of playlist item (MFile, MLive or MPlaylist).  
Public MethodItemPlayTimeGetGets the playlist item playback time including breaks.  
Public MethodItemPosGetGets item position in playlist and breaks.  
Public MethodItemStartTimeSetSets the absolute start time of playlist item.  
Public MethodItemTimesGetGets the absolute start and stop time of playlist item.  
Public MethodItemTypeGetGets the playlist item type  
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 MethodPlaylistAddInserts a new item into the playlist at the specified position.  
Public MethodPlaylistBackgroundGetGets the current playlist background.  
Public MethodPlaylistBackgroundSetSets the background of playlist.  
Public MethodPlaylistCommandAddAdds a command to the playlist.  
Public MethodPlaylistGetByIndexGets the item and the item offset from the start by item index.  
Public MethodPlaylistGetByOffsetGets the item in playlist by the offset time from start.  
Public MethodPlaylistGetCountGets the number of the playlist items and the total playlist duration.  
Public MethodPlaylistPosGetGets the current playlist position (current item index, current item time and current playlist time). The position is calculated from item in-point with calculation of all breaks.  
Public MethodPlaylistPosSetSets the current playlist position to the specified file and time. The position is calculated from item in-point with calculation of all breaks.  
Public MethodPlaylistRemoveRemoves the item from playlist.  
Public MethodPlaylistRemoveByIndexRemoves multiple items from the playlist.  
Public MethodPlaylistReorderChanges the playlist items order.  
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.  
Top
See Also

Reference

MItemClass Class
MPLATFORMLib Namespace