server-proxy-common/su.plo.voice.api.server.audio.source/ServerBroadcastSource

ServerBroadcastSource

interface ServerBroadcastSource : BaseServerDirectSource

Represents a broadcast audio source.

This source broadcasts audio and source packets to the specific group of players.

Properties

addon

@get:NotNull

abstract override val addon: @NotNull AddonContainer

filters

@get:NotNull

abstract override val filters: @NotNull Collection<Predicate<in VoicePlayer?>?>

@get:NotNull

abstract override val id: @NotNull UUID

isCameraRelative

abstract var isCameraRelative: Boolean

Gets or sets whether the source position should be camera relative.

isIconVisible

abstract override var isIconVisible: Boolean

line

@get:NotNull

abstract override val line: @NotNull BaseServerSourceLine

lookAngle

abstract var lookAngle: Pos3d?

Gets or sets the look angle of the source.

players

abstract var players: Collection<@JvmWildcard VoicePlayer>?

Gets or sets the collection of players.

relativePosition

abstract var relativePosition: Pos3d?

Gets or sets the relative position of the source.

sender

abstract var sender: VoicePlayer?

Gets or sets the direct source sender.

sourceInfo

abstract val sourceInfo: DirectSourceInfo?

state

abstract override val state: Int

Functions

addFilter

abstract fun <P : VoicePlayer?> addFilter(@NotNull filter: @NotNull Predicate<in P?>)

Adds a new player filter to the source.

clearFilters

abstract fun clearFilters()

Clears all filters from the source.

createAudioSender

abstract fun createAudioSender(frameProvider: AudioFrameProvider): AudioSender

Creates a new audio sender for this source.

matchFilters

abstract fun <P : VoicePlayer?> matchFilters(@NotNull player: @NotNull P & Any): Boolean

Checks if a player matches all filters associated with this source. Returns false if the player has disabled the voice chat. See isVoiceDisabled.

notMatchFilters

open fun <P : VoicePlayer?> notMatchFilters(@NotNull player: @NotNull P & Any): Boolean

Checks if a player does not match any of the filters associated with this source.

remove

open fun remove()

Removes the source from its associated source line.

removeFilter

abstract fun <P : VoicePlayer?> removeFilter(@NotNull filter: @NotNull Predicate<in P?>)

Removes a player filter from the source.

resolveSourceInfo

@NotNull

abstract fun resolveSourceInfo(): @NotNull CompletableFuture<DirectSourceInfo?>

sendAudioEnd

open fun sendAudioEnd(sequenceNumber: Long): Boolean

Sends an audio end packet.

sendAudioFrame

open fun sendAudioFrame(frame: ByteArray, sequenceNumber: Long): Boolean

Sends an encoded and encrypted audio frame to players with null activation info.

open fun sendAudioFrame(frame: ByteArray, sequenceNumber: Long, activationInfo: PlayerActivationInfo?): Boolean

Sends an encoded and encrypted audio frame to players with an activation info.

sendAudioPacket

open fun sendAudioPacket(packet: SourceAudioPacket): Boolean

Sends an audio packet to players with null activation info.

abstract fun sendAudioPacket(packet: SourceAudioPacket, activationInfo: PlayerActivationInfo?): Boolean

Sends an audio packet to players with activation info.

sendPacket

abstract fun sendPacket(packet: Packet<*>): Boolean

Sends a TCP packet to players.

setDirty

abstract fun setDirty()

Marks the source as "dirty".

setName

abstract fun setName(@Nullable name: @Nullable String?)

Sets the source name that will be visible in the overlay.

setStereo

abstract fun setStereo(stereo: Boolean)

Sets the source mode to stereo.