| 1 | /* $Id: AudioTestServiceClient.h 98103 2023-01-17 14:15:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * AudioTestServiceClient - Audio test execution server, Public Header.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2021-2023 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 26 | */
|
|---|
| 27 |
|
|---|
| 28 | #ifndef VBOX_INCLUDED_SRC_Audio_AudioTestServiceClient_h
|
|---|
| 29 | #define VBOX_INCLUDED_SRC_Audio_AudioTestServiceClient_h
|
|---|
| 30 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 31 | # pragma once
|
|---|
| 32 | #endif
|
|---|
| 33 |
|
|---|
| 34 | #include "AudioTestServiceInternal.h"
|
|---|
| 35 |
|
|---|
| 36 | /**
|
|---|
| 37 | * Structure for maintaining an ATS client.
|
|---|
| 38 | */
|
|---|
| 39 | typedef struct ATSCLIENT
|
|---|
| 40 | {
|
|---|
| 41 | /** Pointer to the selected transport layer. */
|
|---|
| 42 | PCATSTRANSPORT pTransport;
|
|---|
| 43 | /** Pointer to the selected transport instance to use. */
|
|---|
| 44 | PATSTRANSPORTINST pTransportInst;
|
|---|
| 45 | /** The opaque client instance. */
|
|---|
| 46 | PATSTRANSPORTCLIENT pTransportClient;
|
|---|
| 47 | } ATSCLIENT;
|
|---|
| 48 | /** Pointer to an ATS client. */
|
|---|
| 49 | typedef ATSCLIENT *PATSCLIENT;
|
|---|
| 50 |
|
|---|
| 51 | /** @name Creation / destruction.
|
|---|
| 52 | * @{ */
|
|---|
| 53 | int AudioTestSvcClientCreate(PATSCLIENT pClient);
|
|---|
| 54 | void AudioTestSvcClientDestroy(PATSCLIENT pClient);
|
|---|
| 55 | /** @} */
|
|---|
| 56 |
|
|---|
| 57 | /** @name Connection handling.
|
|---|
| 58 | * @{ */
|
|---|
| 59 | int AudioTestSvcClientConnectEx(PATSCLIENT pClient, RTMSINTERVAL msTimeout);
|
|---|
| 60 | int AudioTestSvcClientConnect(PATSCLIENT pClient);
|
|---|
| 61 | int AudioTestSvcClientDisconnect(PATSCLIENT pClient);
|
|---|
| 62 | /** @} */
|
|---|
| 63 |
|
|---|
| 64 | /** @name Option handling.
|
|---|
| 65 | * @{ */
|
|---|
| 66 | int AudioTestSvcClientHandleOption(PATSCLIENT pClient, int ch, PCRTGETOPTUNION pVal);
|
|---|
| 67 | /** @} */
|
|---|
| 68 |
|
|---|
| 69 | /** @name Test set handling.
|
|---|
| 70 | * @{ */
|
|---|
| 71 | int AudioTestSvcClientTestSetBegin(PATSCLIENT pClient, const char *pszTag);
|
|---|
| 72 | int AudioTestSvcClientTestSetEnd(PATSCLIENT pClient, const char *pszTag);
|
|---|
| 73 | int AudioTestSvcClientTestSetDownload(PATSCLIENT pClient, const char *pszTag, const char *pszPathOutAbs);
|
|---|
| 74 | /** @} */
|
|---|
| 75 |
|
|---|
| 76 | /** @name Tone handling.
|
|---|
| 77 | * @{ */
|
|---|
| 78 | int AudioTestSvcClientTonePlay(PATSCLIENT pClient, PAUDIOTESTTONEPARMS pToneParms);
|
|---|
| 79 | int AudioTestSvcClientToneRecord(PATSCLIENT pClient, PAUDIOTESTTONEPARMS pToneParms);
|
|---|
| 80 | /** @} */
|
|---|
| 81 |
|
|---|
| 82 | #endif /* !VBOX_INCLUDED_SRC_Audio_AudioTestServiceClient_h */
|
|---|
| 83 |
|
|---|
