Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioSearchParams

Instance to be passed to AssetService:SearchAudioAsync() to search for audio assets.

This class is not replicated. Its interface does not cross the network boundary.
Memory categoryInstances
Tags: [NotReplicated]

Member index 11

HistoryMember
568Album: string
568Artist: string
731AudioSubType: AudioSubType
731AudioSubtype: AudioSubType
731MaxDuration: int
744MaxPageSize: int
731MinDuration: int
568SearchKeyword: string
744SortType: AudioSortType
568Tag: string
568Title: string
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

Instance to be passed to AssetService:SearchAudioAsync() to search for audio assets.

History 25

Members 11

Album

TypeDefault
string

Searches for audio which belongs to this album. Needs to be an exact match.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Artist

TypeDefault
string

Searches for audio which was created by this artist. Needs to be an exact match.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

AudioSubType

TypeDefault
AudioSubTypeMusic

Searches for audio with this subtype, corresponding to the AudioSubType enum. Defaults to AudioSubType.Music.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

AudioSubtype

TypeDefault
AudioSubTypeMusic

Searches for audio with this subtype, corresponding to the AudioSubType enum. Defaults to AudioSubType.Music.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work. AudioSubType should be used instead.
This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue/false

History 8

Tags: [NotReplicated, Deprecated]

MaxDuration

TypeDefault
int2147483647

Searches for audio with a duration less than or equal to this value.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

MaxPageSize

TypeDefault
int0

The maximum number of results returned per page, up to 100; larger values are treated as 100. When left at the default of 0 the service chooses the page size.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

MinDuration

TypeDefault
int0

Searches for audio with a duration greater than or equal to this value.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

SearchKeyword

TypeDefault
string

Searches for audio relevant to this keyword.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

SortType

TypeDefault
AudioSortTypeRelevance

Controls how results are ordered, corresponding to the AudioSortType enum. Defaults to AudioSortType.Relevance.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Tag

TypeDefault
string

Searches for audio which has this tag. Needs to be an exact match.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Title

TypeDefault
string

Searches for audio with this title. Needs to be an exact match.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Settings