AUMAKEELEMENTIMPORTCLIENT(3x)

πŸ“¦ version 1.9.5, in fedora 43, fedora 44

πŸ’– AuMakeElementImportClient(3) πŸ’–

okay so bestie, welcome to section 3 of the library functions manual πŸŽ€ this one's about a lil function called AuMakeElementImportClient, and it's literally the glow-up ritual for an ImportClient element. it's giving "makeover montage but for audio structs" ✨


🌸 NAME 🌸

AuMakeElementImportClient β€” initialize an ImportClient element πŸ’…


✨ SYNOPSIS ✨

#include <audio/audiolib.h>

AuMakeElementImportClient(element, sample_rate, format, num_tracks,
discard, max_samples, low_water_mark, num_actions, actions)
    AuElement *element; /* RETURN */
    unsigned short sample_rate;
    unsigned char format;
    unsigned char num_tracks;
    unsigned char discard;
    AuUint32 max_samples;
    AuUint32 low_water_mark;
    int num_actions;
    AuElementAction *actions;

like look at that signature, it ate and left no crumbs πŸ”₯


🫢 ARGUMENTS 🫢

  • element β€” this is the RETURN girlie πŸ’« she gets handed back to you all initialized and ready to slay.
  • sample_rate β€” the sample rate of the audio data. iykyk, don't mess it up.
  • format β€” the format of the audio data. rn the following formats are defined, and that's the whole list, no cap:
    • AuFormatULAW8
    • AuFormatLinearUnsigned8
    • AuFormatLinearSigned8
    • AuFormatLinearSigned16MSB
    • AuFormatLinearUnsigned16MSB
    • AuFormatSignedLinear16LSB
    • AuFormatLinearUnsigned16LSB
  • num_tracks β€” how many tracks are in the audio data. yes, plural, she can multitask πŸ’…
  • discard β€” specifies if the import should be paused initally. normally AuTrue. AuFalse may crash the server. not me saying this dramatically but like, it may crash the server, so bestie please just use AuTrue 😭
  • max_samples β€” the maximum number of samples to accept in a single read. lowkey ignored for "trivial" flows πŸ™ˆ
  • low_water_mark β€” this one tells you when to go beg the client application for more audio data. so when this number of samples are left in the buffer, and an EOF hasn't been received, a NotifyEvent with kind set to AuElementNotifyKindLowWater gets sent to the client application. it's giving "hey bestie we're running low, restock pls" πŸ“
  • num_actions β€” the number of actions in actions. simple as.
  • actions β€” the list of actions to associate with this element. entries in this list can be initialized with AuMakeChangeStateAction, AuMakeSendNotifyAction, and AuMakeNoopAction. may be NULL. no actions? no problem πŸ¦‹

🌈 DESCRIPTION 🌈

AuMakeElementImportClient sets the type of element to AuElementTypeImportClient and initializes the importclient member of element with the remaining arguments. that's the whole vibe ✨

also, tea time β˜• AuMakeElementImportClient is implemented as a macro. not a regular function. a macro. periodt.


πŸ‘‘ SEE ALSO πŸ‘‘

the whole friend group fr fr:

  • AuMakeElementAddConstant
  • AuMakeElementBundle
  • AuMakeElementExportClient
  • AuMakeElementExportDevice
  • AuMakeElementExportBucket
  • AuMakeElementExportMonitor
  • AuMakeElementImportDevice
  • AuMakeElementImportBucket
  • AuMakeElementImportWaveForm
  • AuMakeElementMultiplyConstant
  • AuMakeElementSum
  • audiolib β€” Network Audio System C Language Interface πŸ’œ

that's it bestie, go initialize something iconic 🌟

okay that's the whole page, sending you love from audiolib β€” element initialization, version 1.9.5, and yeah the header/footer were doing that AuMakeElem...mportClient(3) abbreviating thing the whole time because the terminal is dramatic like that πŸ’€ mwah, bye! πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from