softwarecontainer  0.18.0-739e8d7 2017-05-04
pulsegateway.h
1 /*
2  * Copyright (C) 2016-2017 Pelagicore AB
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
9  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
10  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
11  * BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
12  * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
13  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
14  * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
15  * SOFTWARE.
16  *
17  * For further information see LICENSE
18  */
19 
20 #pragma once
21 
22 #include "gateway.h"
23 
24 namespace softwarecontainer {
25 
29 class PulseGateway :
30  public Gateway
31 {
32  LOG_DECLARE_CLASS_CONTEXT("PULS", "Pulse gateway");
33 
34  static constexpr const char *PULSE_AUDIO_SERVER_ENVIRONMENT_VARIABLE_NAME = "PULSE_SERVER";
35  static constexpr const char *SOCKET_FILE_NAME = "pulse_socket";
36 
37 public:
38  static constexpr const char *ID = "pulseaudio";
39 
40  PulseGateway(std::shared_ptr<ContainerAbstractInterface> container);
41  ~PulseGateway();
42 
43  bool readConfigElement(const json_t *element) override;
44 
54  virtual bool activateGateway() override;
55 
59  virtual bool teardownGateway() override;
60 
61 private:
62  bool m_enableAudio;
63 
67  virtual bool enablePulseAudio();
68 };
69 
70 } // namespace softwarecontainer
virtual bool activateGateway() override
Implements Gateway::activateGateway.
Gateway base class for SoftwareContainer.
Definition: gateway.h:61
bool readConfigElement(const json_t *element) override
Gateway specific parsing of config elements.
Developers guide to adding a config item:
The PulseAudio Gateway is used to provide access to the host system PulseAudio server.
Definition: pulsegateway.h:29
virtual bool teardownGateway() override
Implements Gateway::teardownGateway.