Method SkipAsync

Namespace

OBSStudioClient.Model

Assembly

OBSClient.dll

SkipAsync(TimeSpan, CancellationToken)

Moves the media forwards or backwards from where it is, and returns when OBS Studio has answered.

public Task SkipAsync(TimeSpan offset, CancellationToken cancellationToken = default)

Parameters

offset TimeSpan

How far to move, in whole milliseconds (a part of a millisecond is rounded): positive goes forwards, negative backwards. OBS Studio stops at the beginning, and does not check against the end.

cancellationToken CancellationToken

A token that ends the wait. A change that was not sent yet is not sent.

Returns

Task

A task that completes when OBS Studio has answered.

Remarks

See SeekAsync(TimeSpan, CancellationToken).

Exceptions

ArgumentOutOfRangeException

offset is more than about 24 days either way.

ObsRemovedException

The input was removed.

ObsNotConnectedException

There is no connection to OBS Studio. Nothing was changed.

ObsNotReadyException

OBS Studio is changing its scene collection, or did so after the call. Nothing was changed.

ObsUnknownOutcomeException

OBS Studio did not answer in time, or the connection ended: it is not known whether it made the change.

ObsResponseException

OBS Studio refused the change: the media neither plays nor is paused (ErrorCode is InvalidResourceState).