VivoxPlayerComponent.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/ActorComponent.h"
#include "VivoxPlayerComponent.generated.h"
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FVivoxChatSignature);
 
UCLASS( ClassGroup=(Custom), meta=(BlueprintSpawnableComponent) )
class PROJECTX_API UVivoxPlayerComponent : public UActorComponent
{
    GENERATED_BODY()
 
public: 
    // Sets default values for this component's properties
    UVivoxPlayerComponent();
    
    //Binds the input from the player controller to our push to talk-related functions
    virtual void SetupPlayerInputComponent(class UInputComponent* PlayerInputComponent);
    //Updates spatial chat positioning, currently disabled
    virtual void TickComponent(float DeltaTime,ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    virtual void BeginPlay() override;
    //External call that auto-resolves the user ID to login and retries if the ID is invalid.
    virtual void Login();
 
    UFUNCTION(BlueprintPure)
    bool IsUsingPushToTalk() const;
 
    UPROPERTY(BlueprintAssignable)
    FVivoxChatSignature OnPushToTalkPressed;
    UPROPERTY(BlueprintAssignable)
    FVivoxChatSignature OnPushToTalkReleased;
 
    //Tries to connect to the SessionName + SquadID
    UFUNCTION(Reliable, Client)
    void Client_JoinSquadVoiceChannel(const FString& SessionName, const int32 SquadID = INDEX_NONE, bool bForceLeaveChannels = true);
    void AttemptJoinSquadVoiceChannel(const FString SessionName, const int32 SquadID);
    UFUNCTION(Reliable, Client)
    void Client_Login();
 
protected:
    //Push to talk bindings
    void PushToTalkTeamChannelPressed();
    void PushToTalkTeamChannelReleased();
    void PushToToggleTeamChannel();
 
    //A toggle control to make sure PPT with a toggle action is correctly being tracked
    bool bPPTToggle = false;
 
    FTimerHandle ClientSquadVoiceChannelJoinHandler;
    int32 CachedSquadID = INDEX_NONE;
        
};