UMagicLeapMusicServiceFunctionLibrary

Provides music playback control of a Music Service Provider

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UMagicLeapMusicServiceFunctionLibrary

References

Module

MagicLeapMusicService

Header

/Engine/Plugins/Lumin/MagicLeapMusicService/Source/MagicLeapMusicService/Public/MagicLeapMusicServiceFunctionLibrary.h

Include

#include "MagicLeapMusicServiceFunctionLibrary.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=MagicLeap)
class UMagicLeapMusicServiceFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

Provides music playback control of a Music Service Provider

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category

bool

 

Connect

(
    const FString& Name
)

Connects to a music service provider

Public function Static UFunction BlueprintCallable, Category

bool

 

Disconnect()

Disconnects from the currently connected service provider.

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetCurrentPosition

(
    FTimespan& Position
)

Gets the current playback position of the currently selected track

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetCurrentTrackMetadata

(
    FMagicLeapMusicServiceTrackMetadata...
)

Gets the currently selected track's metadata

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetPlaybackRepeatState

(
    EMagicLeapMusicServicePlaybackRepea...
)

Gets the current repeat state of the music service provider

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetPlaybackShuffleState

(
    EMagicLeapMusicServicePlaybackShuff...
)

Gets the current playback shuffle state

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetPlaybackState

(
    EMagicLeapMusicServicePlaybackState...
)

Gets the current playback state of the music service provider

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetPlaybackVolume

(
    float& Volume
)

Gets the volume of playback the music service provider is currently set to

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetServiceProviderError

(
    EMagicLeapMusicServiceProviderError...,
    int32& ErrorCode
)

Gets the current error status of the music service provider.

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetServiceStatus

(
    EMagicLeapMusicServiceStatus& Stat...
)

Gets the current service status of the music service provider

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

bool

 

GetTrackLength

(
    FTimespan& Length
)

Gets the length of the currently selected track

Public function Static UFunction BlueprintCallable, Category

bool

 

NextTrack()

Advances to the next track on the music service provider's playlist.

Public function Static UFunction BlueprintCallable, Category

bool

 

PausePlayback()

Pauses playback of the currently selected track.

Public function Static UFunction BlueprintCallable, Category

bool

 

PreviousTrack()

Rewinds to the previous track on the music provider's playlist

Public function Static UFunction BlueprintCallable, Category

bool

 

ResumePlayback()

Resumes playback of the currently selected track.

Public function Static UFunction BlueprintCallable, Category

bool

 

SeekTo

(
    const FTimespan& Position
)

Seeks to a position on the currently selected track.

Public function Static UFunction BlueprintCallable, Category

bool

 

SetAuthenticationString

(
    const FString& AuthenticationStrin...
)

Sets the authentication string used to connect to the music service provider

Public function Static UFunction BlueprintCallable, Category

bool

 

SetCallbacks

(
    const FMagicLeapMusicServiceCallbac...
)

Sets callbacks the music service provider will utilize.

Public function Static UFunction BlueprintCallable, Category

bool

 

SetPlaybackRepeatState

(
    const EMagicLeapMusicServicePlaybac...
)

Sets the repeat state of the music service provider

Public function Static UFunction BlueprintCallable, Category

bool

 

SetPlaybackShuffleState

(
    const EMagicLeapMusicServicePlaybac...
)

Sets the current playback shuffle state

Public function Static UFunction BlueprintCallable, Category

bool

 

SetPlaybackURL

(
    const FString& PlaybackURL
)

Sets the URL to playback using the music service provider

Public function Static UFunction BlueprintCallable, Category

bool

 

SetPlaybackVolume

(
    const float Volume
)

Sets the volume of playback by the music service provider

Public function Static UFunction BlueprintCallable, Category

bool

 

SetPlaylist

(
    const TArray< FString >& Playlist
)

Sets the playlist for the music service provider

Public function Static UFunction BlueprintCallable, Category

bool

 

StartPlayback()

Starts playback of the currently selected track.

Public function Static UFunction BlueprintCallable, Category

bool

 

StopPlayback()

Stops playback of the currently selected track.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss