Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
icecast_client.h File Reference
Icecast client. More...
Go to the source code of this file.
Data Structures | |
| struct | IcecastClientSettings |
| Icecast client settings. More... | |
| struct | IcecastClientContext |
| Icecast client context. More... | |
Functions | |
| void | icecastClientGetDefaultSettings (IcecastClientSettings *settings) |
| Initialize settings with default values. | |
| error_t | icecastClientInit (IcecastClientContext *context, const IcecastClientSettings *settings) |
| Icecast client initialization. | |
| error_t | icecastClientStart (IcecastClientContext *context) |
| Start Icecast client. | |
| error_t | icecastClientReadStream (IcecastClientContext *context, uint8_t *data, size_t size, size_t *length, systime_t timeout) |
| Copy data from input stream. | |
| error_t | icecastClientReadMetadata (IcecastClientContext *context, char_t *metadata, size_t size, size_t *length) |
| Copy metadata from input stream. | |
| void | icecastClientTask (void *param) |
| Icecast client task. | |
| error_t | icecastClientConnect (IcecastClientContext *context) |
| Connect to the specified Icecast server. | |
| error_t | icecastClientProcessMetadata (IcecastClientContext *context) |
| Decode metadata block. | |
Detailed Description
Icecast client.
License
Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version:
- 1.7.6
Definition in file icecast_client.h.
Function Documentation
| error_t icecastClientConnect | ( | IcecastClientContext * | context ) |
Connect to the specified Icecast server.
- Parameters:
-
[in] context Pointer to the Icecast client context
Definition at line 426 of file icecast_client.c.
| void icecastClientGetDefaultSettings | ( | IcecastClientSettings * | settings ) |
Initialize settings with default values.
- Parameters:
-
[out] settings Structure that contains Icecast client settings
Definition at line 47 of file icecast_client.c.
| error_t icecastClientInit | ( | IcecastClientContext * | context, |
| const IcecastClientSettings * | settings | ||
| ) |
Icecast client initialization.
- Parameters:
-
[in] context Pointer to the Icecast client context [in] settings Icecast client specific settings
- Returns:
- Error code
Definition at line 71 of file icecast_client.c.
| error_t icecastClientProcessMetadata | ( | IcecastClientContext * | context ) |
Decode metadata block.
- Parameters:
-
[in] context Pointer to the Icecast client context
Definition at line 592 of file icecast_client.c.
| error_t icecastClientReadMetadata | ( | IcecastClientContext * | context, |
| char_t * | metadata, | ||
| size_t | size, | ||
| size_t * | length | ||
| ) |
Copy metadata from input stream.
- Parameters:
-
[in] context Pointer to the Icecast client context [out] metadata Pointer to the user buffer [in] size Maximum number of bytes that can be read [out] length Number of bytes that have been read
- Returns:
- Error code
Definition at line 261 of file icecast_client.c.
| error_t icecastClientReadStream | ( | IcecastClientContext * | context, |
| uint8_t * | data, | ||
| size_t | size, | ||
| size_t * | length, | ||
| systime_t | timeout | ||
| ) |
Copy data from input stream.
- Parameters:
-
[in] context Pointer to the Icecast client context [out] data Pointer to the user buffer [in] size Maximum number of bytes that can be read [out] length Number of bytes that have been read [in] timeout Maximum time to wait before returning
- Returns:
- Error code
Definition at line 188 of file icecast_client.c.
| error_t icecastClientStart | ( | IcecastClientContext * | context ) |
Start Icecast client.
- Parameters:
-
[in] context Pointer to the Icecast client context
- Returns:
- Error code
Definition at line 158 of file icecast_client.c.
| void icecastClientTask | ( | void * | param ) |
Icecast client task.
- Parameters:
-
[in] param Pointer to the Icecast client context
Definition at line 289 of file icecast_client.c.
Generated on Tue Jul 12 2022 17:10:20 by
1.7.2