AudioStreamPlaylist — C# API

class AudioStreamPlaylistReckfellSharpInherits AudioStream

AudioStream that includes sub-streams and plays them back like a playlist.

An audio stream that can play back sub-streams in sequence. Streams can be added to the Playlist with AudioStreamPlaylist.SetListStream, and shuffled with AudioStreamPlaylist.Shuffle.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioStreamPlaylistConstructor

# AudioStreamPlaylist

C#
public AudioStreamPlaylist();

Properties68

FadeTimeProperty

# FadeTime

C#
public float FadeTime { get; set; }

Fade time used when a stream ends, when going to the next one. Streams are expected to have an extra bit of audio after the end to help with fading.

LoopProperty

# Loop

C#
public bool Loop { get; set; }

If true, the playlist will loop, otherwise the playlist will end when the last stream is finished.

ShuffleProperty

# Shuffle

C#
public bool Shuffle { get; set; }

If true, the playlist will shuffle each time playback starts and each time it loops.

Stream0Property

# Stream0

C#
public AudioStream Stream0 { get; set; }

Stream1Property

# Stream1

C#
public AudioStream Stream1 { get; set; }

Stream10Property

# Stream10

C#
public AudioStream Stream10 { get; set; }

Stream11Property

# Stream11

C#
public AudioStream Stream11 { get; set; }

Stream12Property

# Stream12

C#
public AudioStream Stream12 { get; set; }

Stream13Property

# Stream13

C#
public AudioStream Stream13 { get; set; }

Stream14Property

# Stream14

C#
public AudioStream Stream14 { get; set; }

Stream15Property

# Stream15

C#
public AudioStream Stream15 { get; set; }

Stream16Property

# Stream16

C#
public AudioStream Stream16 { get; set; }

Stream17Property

# Stream17

C#
public AudioStream Stream17 { get; set; }

Stream18Property

# Stream18

C#
public AudioStream Stream18 { get; set; }

Stream19Property

# Stream19

C#
public AudioStream Stream19 { get; set; }

Stream2Property

# Stream2

C#
public AudioStream Stream2 { get; set; }

Stream20Property

# Stream20

C#
public AudioStream Stream20 { get; set; }

Stream21Property

# Stream21

C#
public AudioStream Stream21 { get; set; }

Stream22Property

# Stream22

C#
public AudioStream Stream22 { get; set; }

Stream23Property

# Stream23

C#
public AudioStream Stream23 { get; set; }

Stream24Property

# Stream24

C#
public AudioStream Stream24 { get; set; }

Stream25Property

# Stream25

C#
public AudioStream Stream25 { get; set; }

Stream26Property

# Stream26

C#
public AudioStream Stream26 { get; set; }

Stream27Property

# Stream27

C#
public AudioStream Stream27 { get; set; }

Stream28Property

# Stream28

C#
public AudioStream Stream28 { get; set; }

Stream29Property

# Stream29

C#
public AudioStream Stream29 { get; set; }

Stream3Property

# Stream3

C#
public AudioStream Stream3 { get; set; }

Stream30Property

# Stream30

C#
public AudioStream Stream30 { get; set; }

Stream31Property

# Stream31

C#
public AudioStream Stream31 { get; set; }

Stream32Property

# Stream32

C#
public AudioStream Stream32 { get; set; }

Stream33Property

# Stream33

C#
public AudioStream Stream33 { get; set; }

Stream34Property

# Stream34

C#
public AudioStream Stream34 { get; set; }

Stream35Property

# Stream35

C#
public AudioStream Stream35 { get; set; }

Stream36Property

# Stream36

C#
public AudioStream Stream36 { get; set; }

Stream37Property

# Stream37

C#
public AudioStream Stream37 { get; set; }

Stream38Property

# Stream38

C#
public AudioStream Stream38 { get; set; }

Stream39Property

# Stream39

C#
public AudioStream Stream39 { get; set; }

Stream4Property

# Stream4

C#
public AudioStream Stream4 { get; set; }

Stream40Property

# Stream40

C#
public AudioStream Stream40 { get; set; }

Stream41Property

# Stream41

C#
public AudioStream Stream41 { get; set; }

Stream42Property

# Stream42

C#
public AudioStream Stream42 { get; set; }

Stream43Property

# Stream43

C#
public AudioStream Stream43 { get; set; }

Stream44Property

# Stream44

C#
public AudioStream Stream44 { get; set; }

Stream45Property

# Stream45

C#
public AudioStream Stream45 { get; set; }

Stream46Property

# Stream46

C#
public AudioStream Stream46 { get; set; }

Stream47Property

# Stream47

C#
public AudioStream Stream47 { get; set; }

Stream48Property

# Stream48

C#
public AudioStream Stream48 { get; set; }

Stream49Property

# Stream49

C#
public AudioStream Stream49 { get; set; }

Stream5Property

# Stream5

C#
public AudioStream Stream5 { get; set; }

Stream50Property

# Stream50

C#
public AudioStream Stream50 { get; set; }

Stream51Property

# Stream51

C#
public AudioStream Stream51 { get; set; }

Stream52Property

# Stream52

C#
public AudioStream Stream52 { get; set; }

Stream53Property

# Stream53

C#
public AudioStream Stream53 { get; set; }

Stream54Property

# Stream54

C#
public AudioStream Stream54 { get; set; }

Stream55Property

# Stream55

C#
public AudioStream Stream55 { get; set; }

Stream56Property

# Stream56

C#
public AudioStream Stream56 { get; set; }

Stream57Property

# Stream57

C#
public AudioStream Stream57 { get; set; }

Stream58Property

# Stream58

C#
public AudioStream Stream58 { get; set; }

Stream59Property

# Stream59

C#
public AudioStream Stream59 { get; set; }

Stream6Property

# Stream6

C#
public AudioStream Stream6 { get; set; }

Stream60Property

# Stream60

C#
public AudioStream Stream60 { get; set; }

Stream61Property

# Stream61

C#
public AudioStream Stream61 { get; set; }

Stream62Property

# Stream62

C#
public AudioStream Stream62 { get; set; }

Stream63Property

# Stream63

C#
public AudioStream Stream63 { get; set; }

Stream7Property

# Stream7

C#
public AudioStream Stream7 { get; set; }

Stream8Property

# Stream8

C#
public AudioStream Stream8 { get; set; }

Stream9Property

# Stream9

C#
public AudioStream Stream9 { get; set; }

StreamCountProperty

# StreamCount

C#
public int StreamCount { get; set; }

Amount of streams in the playlist.

Methods11

GetBpmdouble

# GetBpm

C#
public double GetBpm();

Returns the BPM of the playlist, which can vary depending on the clip being played.

Returns double

GetFadeTimefloat

# GetFadeTime

C#
public float GetFadeTime();

Returns float

GetListStreamAudioStream

# GetListStream

C#
public AudioStream GetListStream(int streamIndex);

Returns the stream at playback position index.

Parameters
Name	Type	Default
`streamIndex`	`int`	—

Returns AudioStream

GetShufflebool

# GetShuffle

C#
public bool GetShuffle();

Returns bool

GetStreamCountint

# GetStreamCount

C#
public int GetStreamCount();

Returns int

HasLoopbool

# HasLoop

C#
public bool HasLoop();

Returns bool

SetFadeTimevoid

# SetFadeTime

C#
public void SetFadeTime(float dec);

Parameters
Name	Type	Default
`dec`	`float`	—

SetListStreamvoid

# SetListStream

C#
public void SetListStream(int streamIndex, AudioStream audioStream);

Sets the stream at playback position index.

Parameters
Name	Type	Default
`streamIndex`	`int`	—
`audioStream`	`AudioStream`	—

SetLoopvoid

# SetLoop

C#
public void SetLoop(bool loop);

Parameters
Name	Type	Default
`loop`	`bool`	—

SetShufflevoid

# SetShuffle

C#
public void SetShuffle(bool shuffle);

Parameters
Name	Type	Default
`shuffle`	`bool`	—

SetStreamCountvoid

# SetStreamCount

C#
public void SetStreamCount(int streamCount);

Parameters
Name	Type	Default
`streamCount`	`int`	—

Fields and constants1

MaxStreamsField

# MaxStreams

C#
public const long MaxStreams = 64;

Maximum amount of streams supported in the playlist.