feat: Speaker Api #711

MS-crew · 2026-01-03T12:02:37Z

Description

Describe the changes
This PR restores functional audio playback for the Speaker toy by reintroducing a proper PCM based audio pipeline. The Speaker now actively encodes PCM data using Opus, streams audio in real time, and correctly sends voice packets to clients.

Additionally, this PR introduces a complete Audio API overhaul:
-Seeking Support: Added functionality to jump to specific timestamps in both streamed and preloaded audio.
-Event System: Implemented a full lifecycle event system (OnPlaybackStarted, Paused, Resumed, Stopped, Finished, Looped) for better plugin integration.

High Precision: Switched internal time tracking to double precision to ensure accurate playback timing and seeking.
What is the current behavior? (You can also link to an open issue here)
The current Speaker toy is unable to play any audio. Although audio packets can be sent, no actual playback pipeline exists.

What is the new behavior? (if this is a feature change)
The Speaker can now reliably play audio. It supports streamed and preloaded WAV playback, real-time PCM encoding, looping, targeted or global playback modes, and proper cleanup when playback ends or the toy is removed.

-Playback Pipeline: Real time or Preloaded PCM encoding and streaming.
-WAV Support: Support for both streamed and preloaded WAV playback.
-Advanced Controls: Added Seek(double seconds), CurrentTime, and TotalDuration properties.
-Events: Developers can subscribe to playback events to trigger logic when audio starts, stops, or finishes.
-Flexible Modes: Supports Looping, Targeted (specific players ), Predicate players, or Global playback modes.
-Pitch Support: Dynamic playback speed control with optimized interpolation.
-Cleanup: Proper resource disposal when playback ends or the toy is removed.

Example Videos:

2026-01-04.13-03-42.mp4

2026-01-12_01-55-51.mp4

SPOILER_0121.mp4

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No. This change restores and extends existing functionality without requiring changes from users.

Other information:

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentations

Submission checklist

I have checked the project can be compiled
I have tested my changes and it worked as expected

Patches (if there are any changes related to Harmony patches)

I have checked no IL patching errors in the console

Other

Still requires more testing

Updated XML documentation for the Channel property to include a reference to Channels.

Update PreloadedPcmSource.cs Update Speaker.cs Create WavUtility.cs Update WavStreamSource.cs Update PreloadedPcmSource.cs Change default stream parameter to false in PlayWav Update PlayWav method to default stream to true Change TargetPlayers from List to HashSet

Update PreloadedPcmSource.cs Added another constructor for public usages Update PreloadedPcmSource.cs

- Introduced a full Event system to the Speaker class (Started, Finished, Stopped, Paused, Resumed). - Implemented `Seek()` functionality and added `CurrentTime` / `TotalDuration` properties. - Utilized `double` precision for all time related calculations to ensure accuracy. - Updated `WavStreamSource` and `PreloadedPcmSource` to support the new seeking logic.

-Optimized WAV header skipping (string comparisons to direct uint32 hex checks)

…into SpeakerToyReborn

EXILED/Exiled.API/Features/Audio/WavStreamSource.cs

Someone-193 · 2026-02-02T19:00:25Z

EXILED/Exiled.API/Features/Toys/Speaker.cs

+                case SpeakerPlayMode.Global:
+                    NetworkServer.SendToReady(msg, Channel);
+                    break;
+
+                case SpeakerPlayMode.Player:
+                    TargetPlayer?.Connection.Send(msg, Channel);
+                    break;
+
+                case SpeakerPlayMode.PlayerList:
+                    using (NetworkWriterPooled writer = NetworkWriterPool.Get())
+                    {
+                        NetworkMessages.Pack(msg, writer);
+                        ArraySegment<byte> segment = writer.ToArraySegment();
+
+                        foreach (Player ply in TargetPlayers)
+                        {
+                            ply?.Connection.Send(segment, Channel);
+                        }
+                    }
+
+                    break;
+
+                case SpeakerPlayMode.Predicate:
+                    using (NetworkWriterPooled writer = NetworkWriterPool.Get())
+                    {
+                        NetworkMessages.Pack(msg, writer);
+                        ArraySegment<byte> segment = writer.ToArraySegment();
+
+                        foreach (Player ply in Player.List)
+                        {
+                            if (Predicate(ply))
+                                ply.Connection.Send(segment, Channel);
+                        }
+                    }
+
+                    break;


you could also make this flags based 😎

I'd prefer not to get involved for now; I mean, we can already do things that require flags with predicate or target lists, right?

EXILED/Exiled.API/Features/Toys/Speaker.cs

MS-crew and others added 2 commits January 3, 2026 14:52

Speaker Toy Api

efebf22

.

959fe93

github-actions bot assigned MS-crew Jan 3, 2026

github-actions bot added the API label Jan 3, 2026

MS-crew changed the title ~~Speaker toy reborn~~ feat: Speaker toy Api Extend Jan 3, 2026

MS-crew changed the title ~~feat: Speaker toy Api Extend~~ feat: Speaker toy Api Extending Jan 3, 2026

MS-crew and others added 4 commits January 3, 2026 15:05

chore: trigger CI

0c798d4

added missing doc

f02fd3b

Change default stream parameter to false in PlayWav

b93a350

Improve XML documentation for Channel property

63fc8bf

Updated XML documentation for the Channel property to include a reference to Channels.

MS-crew force-pushed the SpeakerToyReborn branch from bfb5d97 to aa481cb Compare January 3, 2026 23:48

MS-crew added 4 commits January 4, 2026 02:49

Update Speaker.cs

67b3348

Update Speaker.cs

21c91cc

Update performance

052e46d

MS-crew force-pushed the SpeakerToyReborn branch from aa481cb to 052e46d Compare January 3, 2026 23:49

Update Speaker.cs

51298ee

Update PreloadedPcmSource.cs Added another constructor for public usages Update PreloadedPcmSource.cs

MS-crew force-pushed the SpeakerToyReborn branch from 01439ee to 51298ee Compare January 4, 2026 09:48

MS-crew marked this pull request as draft January 5, 2026 09:16

MS-crew force-pushed the SpeakerToyReborn branch from 0c2ba50 to 3f7ce95 Compare January 5, 2026 10:27

MS-crew changed the title ~~feat: Speaker toy Api Extending~~ feat: Speaker Toy Api Reborn Jan 5, 2026

MS-crew marked this pull request as ready for review January 5, 2026 10:33

MS-crew added 7 commits January 5, 2026 13:34

Update Speaker.cs

9285154

Update WavUtility.cs

072aba8

Update Speaker.cs

6b97e0f

Update Speaker.cs

49df481

Update Speaker.cs

ccca1ab

Update Speaker.cs

85193d9

Added OnPlaybackLooped event

89fe70d

MS-crew force-pushed the SpeakerToyReborn branch from 4983722 to ae9992f Compare January 12, 2026 09:09

MS-crew and others added 6 commits January 12, 2026 12:13

Update to c# lang version 14

889ca19

Update Speaker.cs

895fba8

Merge branch 'dev' into SpeakerToyReborn

18b30bc

Enum 4 byte to 1 byte

3abd0b1

-Replaced 'File.ReadAllBytes' with 'ArrayPool<byte>.Shared'

88497de

-Optimized WAV header skipping (string comparisons to direct uint32 hex checks)

Refactor

ae2103f

MS-crew force-pushed the SpeakerToyReborn branch from 0f9357c to ae2103f Compare January 12, 2026 22:37

MS-crew and others added 15 commits January 15, 2026 00:03

Merge remote-tracking branch 'upstream/dev' into SpeakerToyReborn

9457f02

Initialize Channel property with ReliableOrdered2

1bc0db9

Refactor Speaker class properties

d6cf318

Update Speaker.cs

d17ca36

Update Speaker.cs

2b1200c

Merge branch 'SpeakerToyReborn' of https://github.com/MS-crew/EXILEDPR …

a69a69f

…into SpeakerToyReborn

ağhhh

974b3f1

Merge branch 'dev' into SpeakerToyReborn

e8348b0

renamed method

e284fdd

Merge branch 'SpeakerToyReborn' of https://github.com/MS-crew/EXILEDPR …

bb82462

…into SpeakerToyReborn

Added Target Player Play Mode

83494fa

.

60ae713

added lasttrack

f627303

perf

1125e19

Merge branch 'dev' into SpeakerToyReborn

84d7166

Someone-193 reviewed Feb 2, 2026

View reviewed changes

EXILED/Exiled.API/Features/Audio/WavStreamSource.cs Outdated Show resolved Hide resolved

Someone-193 reviewed Feb 2, 2026

View reviewed changes

EXILED/Exiled.API/Features/Toys/Speaker.cs Outdated Show resolved Hide resolved

MS-crew added 2 commits February 2, 2026 22:36

Gc halleder onları

4851844

ö

26d838a

MS-crew requested a review from Someone-193 February 2, 2026 21:16

added lasttrack to finishedTrack

06c0a35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Speaker Api #711

feat: Speaker Api #711

Uh oh!

MS-crew commented Jan 3, 2026 •

edited

Loading

Uh oh!

Uh oh!

Someone-193 Feb 2, 2026

Uh oh!

MS-crew Feb 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: Speaker Api #711

Are you sure you want to change the base?

feat: Speaker Api #711

Uh oh!

Conversation

MS-crew commented Jan 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Submission checklist

Patches (if there are any changes related to Harmony patches)

Other

Uh oh!

Uh oh!

Someone-193 Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

MS-crew Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MS-crew commented Jan 3, 2026 •

edited

Loading