media_player_interface.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NUGU_MEDIA_PLAYER_INTERFACE_H__
#define __NUGU_MEDIA_PLAYER_INTERFACE_H__
 
#include <string>
 
#include <base/nugu_audio.h>
#include <nugu.h>
 
namespace NuguClientKit {
 
enum class MediaPlayerState {
    IDLE, 
    PREPARE, 
    READY, 
    PLAYING, 
    PAUSED, 
    STOPPED 
};
 
enum class MediaPlayerEvent {
    INVALID_MEDIA_URL, 
    LOADING_MEDIA_FAILED, 
    LOADING_MEDIA_SUCCESS, 
    PLAYING_MEDIA_FINISHED, 
    PLAYING_MEDIA_UNDERRUN 
};
 
class NUGU_API IMediaPlayerListener {
public:
    virtual ~IMediaPlayerListener() = default;
 
    virtual void mediaStateChanged(MediaPlayerState state) = 0;
 
    virtual void mediaEventReport(MediaPlayerEvent event) = 0;
 
    virtual void mediaChanged(const std::string& url) = 0;
 
    virtual void durationChanged(int duration) = 0;
 
    virtual void positionChanged(int position) = 0;
 
    virtual void volumeChanged(int volume) = 0;
 
    virtual void muteChanged(int mute) = 0;
};
 
class NUGU_API IMediaPlayer {
public:
    virtual ~IMediaPlayer() = default;
 
    virtual void addListener(IMediaPlayerListener* listener) = 0;
 
    virtual void removeListener(IMediaPlayerListener* listener) = 0;
 
    virtual void setAudioAttribute(NuguAudioAttribute attr) = 0;
 
    virtual bool setSource(const std::string& url) = 0;
 
    virtual bool play() = 0;
 
    virtual bool stop() = 0;
 
    virtual bool pause() = 0;
 
    virtual bool resume() = 0;
 
    virtual bool seek(int sec) = 0;
 
    virtual int position() = 0;
 
    virtual bool setPosition(int position) = 0;
 
    virtual bool loop() = 0;
 
    virtual void setLoop(bool loop) = 0;
 
    virtual int duration() = 0;
 
    virtual bool setDuration(int duration) = 0;
 
    virtual int volume() = 0;
 
    virtual bool setVolume(int volume) = 0;
 
    virtual bool mute() = 0;
 
    virtual bool setMute(bool mute) = 0;
 
    virtual bool isPlaying() = 0;
 
    virtual MediaPlayerState state() = 0;
 
    virtual bool setState(MediaPlayerState state) = 0;
 
    virtual std::string stateString(MediaPlayerState state) = 0;
 
    virtual std::string url() = 0;
};
 
class NUGU_API ITTSPlayer : public IMediaPlayer {
public:
    virtual ~ITTSPlayer() = default;
 
    virtual bool writeAudio(const char* data, int size) = 0;
 
    virtual void writeDone() = 0;
};
 
} // NuguClientKit
 
#endif