Microsoft DirectX 8.0

AMTimelineGroup Object

Sets and retrieves properties on groups in Microsoft® DirectShow® Editing Services (DES).

A group contains one or more tracks, and possibly one or more compositions, which in turn contain source clips of a uniform type, such as video or audio. Groups are the topmost compositions in a timeline, and also support the AMTimelineComp object. A timeline can contain multiple groups.

Each group has the following attributes:

Methods

ClearRecompressFormatDirtyNot supported for Visual Basic.
GetGroupNameRetrieves the application-defined name of the group.
GetMediaTypeNot supported for Visual Basic.
GetOutputBufferingRetrieves the number of frames rendered in advance during preview.
GetOutputFPSRetrieves the output frame rate of this group.
GetPreviewModeRetrieves the preview mode for the group.
GetPriorityRetrieves the group's priority.
GetSmartRecompressFormatNot supported for Visual Basic.
GetTimelineRetrieves the timeline to which this group belongs.
IsRecompressFormatDirtyNot supported for Visual Basic.
IsSmartRecompressFormatSetNot supported for Visual Basic.
SetGroupNameSets the application-defined name of the group.
SetMediaTypeNot supported for Visual Basic.
SetMediaTypeForVBSpecifies the media type for the group.
SetOutputBufferingSpecifies the number of frames rendered in advance during preview.
SetOutputFPSSets the uncompressed output frame rate for this group.
SetPreviewModeSets the preview mode for the group.
SetRecompFormatFromSourceSets the video recompression format using the compression format from a source file.
SetSmartRecompressFormatNot supported for Visual Basic.
SetTimelineNot supported for Visual Basic.

ClearRecompressFormatDirty Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic.

Syntax

object.ClearRecompressFormatDirty()

GetGroupName Method (AMTimelineGroup Object)

AMTimelineGroup Object

Retrieves the application-defined name of the group.

Syntax

object.GetGroupName() As String

Parts

object
Object expression that evaluates to an AMTimelineGroup object.

Return Value

Returns the application-defined name of the group.

Error Codes

If the method fails, an error is raised.

GetMediaType Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic.

Syntax

object.GetMediaType(
    pmt As _AMMediaType
)

GetOutputBuffering Method (AMTimelineGroup Object)

AMTimelineGroup Object

Retrieves the number of frames rendered in advance during preview.

Syntax

object.GetOutputBuffering(
    pnBuffer As Long
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
pnBuffer
Variable that receives the number of buffered frames.

Error Codes

If the method fails, an error is raised.

GetOutputFPS Method (AMTimelineGroup Object)

AMTimelineGroup Object

Retrieves the output frame rate of this group.

Syntax

object.GetOutputFPS(
    pFPS As Double
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
pFPS
Variable that receives the output frame rate, in frames per second.

Error Codes

If the method fails, an error is raised.

GetPreviewMode Method (AMTimelineGroup Object)

AMTimelineGroup Object

Retrieves the preview mode for the group.

Syntax

object.GetPreviewMode(
    pfPreview As Long
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
pfPreview
Variable that receives a value indicating the preview mode. If zero, the group is in authoring mode. If non-zero, the group is in preview mode.

Error Codes

If the method fails, an error is raised.

Remarks

In preview mode, frames are dropped during slow effects or transitions to keep the video synchronized with the audio. The video might look choppy as a result. In authoring mode, every frame is rendered. Authoring mode is appropriate for writing files; for on-screen preview, the video might become out of sync with the audio.

GetPriority Method (AMTimelineGroup Object)

AMTimelineGroup Object

Retrieves the group's priority.

Syntax

object.GetPriority(
    pPriority As Long
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
pPriority
Variable that receives the group's priority.

Error Codes

If the method fails, an error is raised.

GetSmartRecompressFormat Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic.

Syntax

object.GetSmartRecompressFormat(
   ppFormat As Long
)

GetTimeline Method (AMTimelineGroup Object)

AMTimelineGroup Object

Retrieves the timeline to which this group belongs.

Syntax

object.GetTimeline(
    ppTimeline As AMTimeline
)

Parts

object
Object expression that evaluates to an AMTimeline object.
ppTimeline
AMTimeline object that receives the timeline. If the group is not part of a timeline, the object is set to Nothing.

Error Codes

If the method fails, an error is raised.

IsRecompressFormatDirty Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic.

Syntax

object.IsRecompressFormatDirty(
    pVal As Long
)

IsSmartRecompressFormatSet Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic.

Syntax

object.IsSmartRecompressFormatSet(
    pVal As Long
)

SetGroupName Method (AMTimelineGroup Object)

AMTimelineGroup Object

Sets the application-defined name of the group.

Syntax

object.SetGroupName(
    pGroupName As String
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
pGroupName
Name of the group.

Error Codes

If the method fails, an error is raised.

SetMediaType Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic. Use the SetMediaTypeForVB method instead.

Syntax

object.SetMediaType(
    pmt As _AMMediaType
)

SetMediaTypeForVB Method (AMTimelineGroup Object)

AMTimelineGroup Object

Specifies the media type for the group.

Syntax

object.SetMediaTypeForVB(
    Val As Long
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
Val
Value that specifies the media type:
ZeroVideo
Non-zeroAudio

Error Codes

If the method fails, an error is raised.

Remarks

This method supports the following formats.

SetOutputBuffering Method (AMTimelineGroup Object)

AMTimelineGroup Object

Specifies the number of frames rendered in advance during preview.

Syntax

object.SetOutputBuffering(
    nBuffer As Long
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
nBuffer
Number of frames to buffer during preview. Must be two or greater.

Error Codes

If the method fails, an error is raised, and Err.Number can be set to one of the following values:

E_INVALIDARGInvalid argument.

Remarks

A larger buffer requires more memory but can result in smoother previewing, especially during effects or transitions that require more time to render. The default buffer is 30 frames.

SetOutputFPS Method (AMTimelineGroup Object)

AMTimelineGroup Object

Sets the uncompressed output frame rate for this group.

Syntax

object.SetOutputFPS(
    FPS As Double
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
FPS
Output frame rate for this group, in frames per second. The value cannot equal zero, and cannot have more than seven digits after the decimal place.

Error Codes

If the method fails, an error is raised, and Err.Number can be set to one of the following values:

E_INVALIDARGInvalid argument.

Remarks

Rendered output from this group runs at the specified frame rate, and all edits on the source material are rounded to the nearest frame boundary, as defined by the frame rate.

SetPreviewMode Method (AMTimelineGroup Object)

AMTimelineGroup Object

Sets the preview mode for the group.

Syntax

object.SetPreviewMode(
    fPreview As Long
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
fPreview
Value that specifies the preview mode. If zero, the group is in authoring mode. If non-zero, the group is in preview mode.

Error Codes

If the method fails, an error is raised.

Remarks

In preview mode, frames are dropped during slow effects or transitions to keep the video synchronized with the audio. The video might look choppy as a result. In authoring mode, every frame is rendered. Authoring mode is appropriate for writing files; for on-screen preview, the video might be out of sync with the audio.

SetRecompFormatFromSource (AMTimelineGroup Object)

AMTimelineGroup Object

Sets the video recompression format using the compression format from a source file.

Syntax

object.SetRecompFormatFromSource( 
    pSource As AMTimelineSrc
)

Parts

object
Object expression that evaluates to an AMTimelineGroup object.
pSource
IAMTimelineSrc object.

Error Codes

If the method fails, an error is raised, and Err.Number can be set to one of the following values:

E_NO_TIMELINEThe group is not within a timeline.
E_OUTOFMEMORYInsufficient memory.
VFW_E_INVALIDMEDIATYPESource file has no video stream.

Remarks

This method finds the source file associated with pSource, retrieves the media type of the first video stream in the file, and sets the group compression format using that type.

SetSmartRecompressFormat Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic.

Syntax

object.SetSmartRecompressFormat(
    pFormat As Long
)

SetTimeline Method (AMTimelineGroup Object)

AMTimelineGroup Object

Not supported for Visual Basic.

Syntax

object.SetTimeline(
    pTimeline As AMTimeline
)