IKStudioPlayback Interface

[This documentation is preliminary and is subject to change.]

Kinect Studio interface for playing a previously recorded Xbox Event File (XEF).

Syntax

public interface class IKStudioPlayback

Members

IKStudioPlayback has the following members.

Properties

Name	Description
Flags	Flags to control playback.
Source	Retrieves the IKStudioClipSource associated with the playback.

Methods

Name	Description
ClearPausePointsAsync	Deletes all pause points.
GetCurrentLoopIterationAsync	Gets the current loop iteration.
GetCurrentRelativeTimeAsync	Gets the current relative time.
GetDurationAsync	Gets the duration of the current clip.
GetEndBehaviorAsync	Gets what the behavior will be at end of playback.
GetInPointByRelativeTimeAsync	Gets an in point by relative time.
GetLoopCountAsync	Gets the loop count, which indicates how many times the file is played back.
GetMetadata	Gets the metadata.
GetMetadataForStream	Gets the metadata for a stream.
GetModeAsync	Gets the mode of playback.
GetOutPointByRelativeTimeAsync	Gets an out point by relative time.
GetPausePointsByRelativeTimeAsync	Gets a collection of pause points by relative time.
GetStartRelativeTimeAsync	Gets the start of relative time of playback.
GetStateAsync	Gets the state of asynchronous playback.
PauseAsync	Pauses asynchronous playback.
ResumeAsync	Resumes asynchronous playback.
SeekByRelativeTimeAsync	Seeks a playback point by relative time.
SetCurrentLoopIterationAsync	Sets the current loop iteration.
SetEndBehaviorAsync	Sets the behavior at end of playback.
SetInPointByRelativeTimeAsync	Sets an in point by relative time.
SetLoopCountAsync	Sets the loop count.
SetModeAsync	Sets the mode for playback.
SetOutPointByRelativeTimeAsync	Sets an out point by relative time.
SetPausePointByRelativeTimeAsync	Sets a pause point by relative time.
StartAsync	Starts playback.
StartPausedAsync	Starts a paused asynchronous action.
StepOnceAsync	Steps once.
StepOnceByStreamAsync	Steps once by stream.
StepOnceByStreamIdentifierAsync	Steps once by stream identifier.
StepOnceByStreamTypeAsync	Steps once by stream type.
StopAsync	Stops playback.

Remarks

To obtain an IKStudioPlayback interface, call KStudioClient::CreatePlaybackFromFileAsync.

To start and stop the playback, call IKStudioPlayback::StartAsync and IKStudioPlayback::StopAsync.

When done using the interface, call IKStudioPlayback::Release.

Requirements

Namespace: Microsoft.Kinect.Tools
Assembly: (in )