Interface IAnimation

Namespace

Selenium.WebDriver.BiDi.Cdp.Animation

Assembly

Selenium.WebDriver.BiDi.Cdp.dll

[Experimental("BIDICDP001")]
public interface IAnimation

Properties

AnimationCanceled

Event for when an animation has been cancelled.

IEventSource<AnimationCanceledEventArgs> AnimationCanceled { get; }

Property Value

IEventSource<AnimationCanceledEventArgs>

Remarks

Event args (AnimationCanceledEventArgs):

• Id - Id of the animation that was cancelled.

AnimationCreated

Event for each animation that has been created.

IEventSource<AnimationCreatedEventArgs> AnimationCreated { get; }

Property Value

IEventSource<AnimationCreatedEventArgs>

Remarks

Event args (AnimationCreatedEventArgs):

• Id - Id of the animation that was created.

AnimationStarted

Event for animation that has been started.

IEventSource<AnimationStartedEventArgs> AnimationStarted { get; }

Property Value

IEventSource<AnimationStartedEventArgs>

Remarks

Event args (AnimationStartedEventArgs):

• Animation - Animation that was started.

AnimationUpdated

Event for animation that has been updated.

IEventSource<AnimationUpdatedEventArgs> AnimationUpdated { get; }

Property Value

IEventSource<AnimationUpdatedEventArgs>

Remarks

Event args (AnimationUpdatedEventArgs):

• Animation - Animation that was updated.

Methods

DisableAsync(string?, CancellationToken)

Disables animation domain notifications.

Task<DisableResult> DisableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DisableResult>

A task representing the asynchronous operation, containing a DisableResult.

EnableAsync(string?, CancellationToken)

Enables animation domain notifications.

Task<EnableResult> EnableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<EnableResult>

A task representing the asynchronous operation, containing a EnableResult.

GetCurrentTimeAsync(string, string?, CancellationToken)

Returns the current time of the an animation.

Task<GetCurrentTimeResult> GetCurrentTimeAsync(string id, string? session = null, CancellationToken cancellationToken = default)

Parameters

id string

Id of animation.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetCurrentTimeResult>

A task representing the asynchronous operation, containing a GetCurrentTimeResult.

GetPlaybackRateAsync(string?, CancellationToken)

Gets the playback rate of the document timeline.

Task<GetPlaybackRateResult> GetPlaybackRateAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetPlaybackRateResult>

A task representing the asynchronous operation, containing a GetPlaybackRateResult.

ReleaseAnimationsAsync(ImmutableArray<string>, string?, CancellationToken)

Releases a set of animations to no longer be manipulated.

Task<ReleaseAnimationsResult> ReleaseAnimationsAsync(ImmutableArray<string> animations, string? session = null, CancellationToken cancellationToken = default)

Parameters

animations ImmutableArray<string>

List of animation ids to seek.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReleaseAnimationsResult>

A task representing the asynchronous operation, containing a ReleaseAnimationsResult.

ResolveAnimationAsync(string, string?, CancellationToken)

Gets the remote object of the Animation.

Task<ResolveAnimationResult> ResolveAnimationAsync(string animationId, string? session = null, CancellationToken cancellationToken = default)

Parameters

animationId string

Animation id.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ResolveAnimationResult>

A task representing the asynchronous operation, containing a ResolveAnimationResult.

SeekAnimationsAsync(ImmutableArray<string>, double, string?, CancellationToken)

Seek a set of animations to a particular time within each animation.

Task<SeekAnimationsResult> SeekAnimationsAsync(ImmutableArray<string> animations, double currentTime, string? session = null, CancellationToken cancellationToken = default)

Parameters

animations ImmutableArray<string>

List of animation ids to seek.

currentTime double

Set the current time of each animation.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SeekAnimationsResult>

A task representing the asynchronous operation, containing a SeekAnimationsResult.

SetPausedAsync(ImmutableArray<string>, bool, string?, CancellationToken)

Sets the paused state of a set of animations.

Task<SetPausedResult> SetPausedAsync(ImmutableArray<string> animations, bool paused, string? session = null, CancellationToken cancellationToken = default)

Parameters

animations ImmutableArray<string>

Animations to set the pause state of.

paused bool

Paused state to set to.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetPausedResult>

A task representing the asynchronous operation, containing a SetPausedResult.

SetPlaybackRateAsync(double, string?, CancellationToken)

Sets the playback rate of the document timeline.

Task<SetPlaybackRateResult> SetPlaybackRateAsync(double playbackRate, string? session = null, CancellationToken cancellationToken = default)

Parameters

playbackRate double

Playback rate for animations on page

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetPlaybackRateResult>

A task representing the asynchronous operation, containing a SetPlaybackRateResult.

SetTimingAsync(string, double, double, string?, CancellationToken)

Sets the timing of an animation node.

Task<SetTimingResult> SetTimingAsync(string animationId, double duration, double delay, string? session = null, CancellationToken cancellationToken = default)

Parameters

animationId string

Animation id.

duration double

Duration of the animation.

delay double

Delay of the animation.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetTimingResult>

A task representing the asynchronous operation, containing a SetTimingResult.