Class AudioPlayerPlayClipInput

Input data transfer object for playing an audio clip in the audio player.

Inheritance
object
AudioPlayerPlayClipInput
Inherited Members
Namespace: Serenity.AudioPlayer.Application.DTO
Assembly: Serenity.AudioPlayer.Application.dll
Syntax
public class AudioPlayerPlayClipInput

Constructors

AudioPlayerPlayClipInput(string, AudioPlayerClip, AudioWorldPosition?, float)

Initializes a new instance of the AudioPlayerPlayClipInput class.

Declaration
public AudioPlayerPlayClipInput(string serviceId, AudioPlayerClip audioPlayerClip, AudioWorldPosition? playbackPosition = null, float clipStartOffsetSeconds = 0)
Parameters
Type Name Description
string serviceId

Identifier of the audio player service to play the clip for.
AudioPlayerClip audioPlayerClip

The audio clip to be played.
AudioWorldPosition? playbackPosition

Optional world position to play at; when set the sound is 3D at that point, otherwise it is 2D.
float clipStartOffsetSeconds

Offset from the start of the clip, in seconds, at which playback begins. Defaults to 0.

Fields

AudioPlayerClip

Declaration
public AudioPlayerClip AudioPlayerClip
Field Value
Type Description
AudioPlayerClip

The audio clip to be played.

ClipStartOffsetSeconds

Declaration
public float ClipStartOffsetSeconds
Field Value
Type Description
float

Offset from the start of the clip, in seconds, at which playback should begin. Defaults to 0 (start of the clip). Used to resume a tail-preserving loop from its loop-return point.

PlaybackPosition

Declaration
public AudioWorldPosition? PlaybackPosition
Field Value
Type Description
AudioWorldPosition?

Optional world position to play the clip at. When set, the sound is played as 3D at that position; when null, the sound is played as 2D and the emitter is not relocated.

ServiceId

Declaration
public string ServiceId
Field Value
Type Description
string

Identifier of the audio player service to play the clip for.