VirtualBox

source: vbox/trunk/src/VBox/Devices/Audio/AudioTestServiceClient.h

Last change on this file was 106061, checked in by vboxsync, 3 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.6 KB
Line 
1/* $Id: AudioTestServiceClient.h 106061 2024-09-16 14:03:52Z vboxsync $ */
2/** @file
3 * AudioTestServiceClient - Audio test execution server, Public Header.
4 */
5
6/*
7 * Copyright (C) 2021-2024 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 */
39typedef 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. */
49typedef ATSCLIENT *PATSCLIENT;
50
51/** @name Creation / destruction.
52 * @{ */
53int AudioTestSvcClientCreate(PATSCLIENT pClient);
54void AudioTestSvcClientDestroy(PATSCLIENT pClient);
55/** @} */
56
57/** @name Connection handling.
58 * @{ */
59int AudioTestSvcClientConnectEx(PATSCLIENT pClient, RTMSINTERVAL msTimeout);
60int AudioTestSvcClientConnect(PATSCLIENT pClient);
61int AudioTestSvcClientDisconnect(PATSCLIENT pClient);
62/** @} */
63
64/** @name Option handling.
65 * @{ */
66int AudioTestSvcClientHandleOption(PATSCLIENT pClient, int ch, PCRTGETOPTUNION pVal);
67/** @} */
68
69/** @name Test set handling.
70 * @{ */
71int AudioTestSvcClientTestSetBegin(PATSCLIENT pClient, const char *pszTag);
72int AudioTestSvcClientTestSetEnd(PATSCLIENT pClient, const char *pszTag);
73int AudioTestSvcClientTestSetDownload(PATSCLIENT pClient, const char *pszTag, const char *pszPathOutAbs);
74/** @} */
75
76/** @name Tone handling.
77 * @{ */
78int AudioTestSvcClientTonePlay(PATSCLIENT pClient, PAUDIOTESTTONEPARMS pToneParms);
79int AudioTestSvcClientToneRecord(PATSCLIENT pClient, PAUDIOTESTTONEPARMS pToneParms);
80/** @} */
81
82#endif /* !VBOX_INCLUDED_SRC_Audio_AudioTestServiceClient_h */
83
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette