drop class names in docs
various style fixes git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18832 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
parent
d0641c6210
commit
d655064c93
headers/os/midi2
src/documentation/haiku_book/midi
@ -23,7 +23,7 @@ private:
|
||||
friend class BMidiRoster;
|
||||
friend class BPrivate::BMidiRosterLooper;
|
||||
|
||||
BMidiProducer(const char* name = NULL);
|
||||
BMidiProducer(const char *name = NULL);
|
||||
virtual ~BMidiProducer();
|
||||
|
||||
virtual void _Reserved1();
|
||||
@ -35,12 +35,12 @@ private:
|
||||
virtual void _Reserved7();
|
||||
virtual void _Reserved8();
|
||||
|
||||
status_t SendConnectRequest(BMidiConsumer*, bool);
|
||||
void ConnectionMade(BMidiConsumer*);
|
||||
bool ConnectionBroken(BMidiConsumer*);
|
||||
status_t SendConnectRequest(BMidiConsumer *, bool);
|
||||
void ConnectionMade(BMidiConsumer *);
|
||||
bool ConnectionBroken(BMidiConsumer *);
|
||||
|
||||
int32 CountConsumers() const;
|
||||
BMidiConsumer* ConsumerAt(int32) const;
|
||||
BMidiConsumer *ConsumerAt(int32) const;
|
||||
|
||||
bool LockProducer() const;
|
||||
void UnlockProducer() const;
|
||||
@ -61,7 +61,7 @@ public:
|
||||
virtual void Disconnected(BMidiConsumer *cons);
|
||||
|
||||
void SprayData(
|
||||
void* data, size_t length, bool atomic = false,
|
||||
void *data, size_t length, bool atomic = false,
|
||||
bigtime_t time = 0) const;
|
||||
|
||||
void SprayNoteOff(
|
||||
@ -90,7 +90,7 @@ public:
|
||||
uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const;
|
||||
|
||||
void SpraySystemExclusive(
|
||||
void* data, size_t length, bigtime_t time = 0) const;
|
||||
void *data, size_t length, bigtime_t time = 0) const;
|
||||
|
||||
void SpraySystemCommon(
|
||||
uchar status, uchar data1, uchar data2, bigtime_t time = 0) const;
|
||||
@ -108,7 +108,7 @@ protected:
|
||||
private:
|
||||
|
||||
void SprayEvent(
|
||||
const void* data, size_t length, bool atomic, bigtime_t time,
|
||||
const void *data, size_t length, bool atomic, bigtime_t time,
|
||||
bool sysex = false) const;
|
||||
|
||||
virtual void _Reserved1();
|
||||
|
@ -32,21 +32,21 @@ class BMidiRoster
|
||||
{
|
||||
public:
|
||||
|
||||
static BMidiEndpoint* NextEndpoint(int32* id);
|
||||
static BMidiProducer* NextProducer(int32* id);
|
||||
static BMidiConsumer* NextConsumer(int32* id);
|
||||
static BMidiEndpoint *NextEndpoint(int32 *id);
|
||||
static BMidiProducer *NextProducer(int32 *id);
|
||||
static BMidiConsumer *NextConsumer(int32 *id);
|
||||
|
||||
static BMidiEndpoint* FindEndpoint(int32 id, bool localOnly = false);
|
||||
static BMidiProducer* FindProducer(int32 id, bool localOnly = false);
|
||||
static BMidiConsumer* FindConsumer(int32 id, bool localOnly = false);
|
||||
static BMidiEndpoint *FindEndpoint(int32 id, bool localOnly = false);
|
||||
static BMidiProducer *FindProducer(int32 id, bool localOnly = false);
|
||||
static BMidiConsumer *FindConsumer(int32 id, bool localOnly = false);
|
||||
|
||||
static void StartWatching(const BMessenger* msngr);
|
||||
static void StartWatching(const BMessenger *msngr);
|
||||
static void StopWatching();
|
||||
|
||||
static status_t Register(BMidiEndpoint* endp);
|
||||
static status_t Unregister(BMidiEndpoint* endp);
|
||||
static status_t Register(BMidiEndpoint *endp);
|
||||
static status_t Unregister(BMidiEndpoint *endp);
|
||||
|
||||
static BMidiRoster* MidiRoster();
|
||||
static BMidiRoster *MidiRoster();
|
||||
|
||||
private:
|
||||
|
||||
|
@ -16,7 +16,7 @@
|
||||
</para>
|
||||
|
||||
<sect3 id="BMidiConsumer_Latency">
|
||||
<title>bigtime_t BMidiConsumer::Latency() const</title>
|
||||
<title>bigtime_t Latency() const</title>
|
||||
|
||||
<para>
|
||||
The latency is measured in microseconds. Producers should attempt to get MIDI
|
||||
|
@ -26,7 +26,7 @@
|
||||
</para>
|
||||
|
||||
<sect3 id="bmidiendpoint_name">
|
||||
<title>const char* BMidiEndpoint::Name() const</title>
|
||||
<title>const char* Name() const</title>
|
||||
|
||||
<para>
|
||||
Returns the name of the endpoint.
|
||||
@ -44,7 +44,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_setname">
|
||||
<title>void BMidiEndpoint::SetName(const char* name)</title>
|
||||
<title>void SetName(const char* name)</title>
|
||||
|
||||
<para>
|
||||
Changes the name of the endpoint.
|
||||
@ -73,7 +73,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_id">
|
||||
<title>int32 BMidiEndpoint::ID() const</title>
|
||||
<title>int32 ID() const</title>
|
||||
|
||||
<para>
|
||||
Returns the ID of the endpoint
|
||||
@ -89,7 +89,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_isproducer">
|
||||
<title>bool BMidiEndpoint::IsProducer() const</title>
|
||||
<title>bool IsProducer() const</title>
|
||||
|
||||
<para>
|
||||
Determines whether this endpoint is a BMidiProducer
|
||||
@ -109,7 +109,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_isconsumer">
|
||||
<title>bool BMidiEndpoint::IsConsumer() const</title>
|
||||
<title>bool IsConsumer() const</title>
|
||||
|
||||
<para>
|
||||
Determines whether this endpoint is a BMidiConsumer
|
||||
@ -128,7 +128,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_isremote">
|
||||
<title>bool BMidiEndpoint::IsRemote() const</title>
|
||||
<title>bool IsRemote() const</title>
|
||||
|
||||
<para>
|
||||
Determines whether this endpoint is a proxy for a remote object.
|
||||
@ -142,7 +142,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_islocal">
|
||||
<title>bool BMidiEndpoint::IsLocal() const</title>
|
||||
<title>bool IsLocal() const</title>
|
||||
|
||||
<para>
|
||||
Determines whether this endpoint represents a local object
|
||||
@ -155,7 +155,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_ispersistent">
|
||||
<title>bool BMidiEndpoint::IsPersistent() const</title>
|
||||
<title>bool IsPersistent() const</title>
|
||||
|
||||
<para>
|
||||
Not used
|
||||
@ -172,7 +172,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_isvalid">
|
||||
<title>bool BMidiEndpoint::IsValid() const</title>
|
||||
<title>bool IsValid() const</title>
|
||||
|
||||
<para>
|
||||
Determines whether the endpoint still exists
|
||||
@ -203,7 +203,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_acquire">
|
||||
<title>status_t BMidiEndpoint::Acquire()</title>
|
||||
<title>status_t Acquire()</title>
|
||||
|
||||
<para>
|
||||
Increments the endpoint's reference count
|
||||
@ -252,7 +252,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_release">
|
||||
<title>status_t BMidiEndpoint::Release()</title>
|
||||
<title>status_t Release()</title>
|
||||
|
||||
<para>
|
||||
Decrements the endpoint's reference count
|
||||
@ -268,7 +268,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_register">
|
||||
<title>status_t BMidiEndpoint::Register()</title>
|
||||
<title>status_t Register()</title>
|
||||
|
||||
<para>
|
||||
Publishes the endpoint on the roster
|
||||
@ -317,7 +317,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_unregister">
|
||||
<title>status_t BMidiEndpoint::Unregister()</title>
|
||||
<title>status_t Unregister()</title>
|
||||
|
||||
<para>
|
||||
Hides the endpoint from the roster
|
||||
@ -329,7 +329,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_setproperties">
|
||||
<title>status_t BMidiEndpoint::SetProperties(const BMessage* properties)</title>
|
||||
<title>status_t SetProperties(const BMessage* properties)</title>
|
||||
|
||||
<para>
|
||||
Changes the properties of the endpoint
|
||||
@ -423,7 +423,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiendpoint_getproperties">
|
||||
<title>status_t BMidiEndpoint::GetProperties(BMessage* properties) const</title>
|
||||
<title>status_t GetProperties(BMessage* properties) const</title>
|
||||
|
||||
<para>
|
||||
Reads the properties of the endpoint
|
||||
|
@ -46,7 +46,7 @@
|
||||
</para>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_bmidilocalconsumer">
|
||||
<title>BMidiLocalConsumer::BMidiLocalConsumer(const char *name = NULL)</title>
|
||||
<title>BMidiLocalConsumer(const char *name = NULL)</title>
|
||||
|
||||
<para>
|
||||
Creates a new local consumer endpoint.
|
||||
@ -82,7 +82,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_setlatency">
|
||||
<title>void BMidiLocalConsumer::SetLatency(bigtime_t latency)</title>
|
||||
<title>void SetLatency(bigtime_t latency)</title>
|
||||
|
||||
<para>
|
||||
Changes the published latency of the consumer.
|
||||
@ -91,7 +91,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_getproducerid">
|
||||
<title>int32 BMidiLocalConsumer::GetProducerID()</title>
|
||||
<title>int32 GetProducerID()</title>
|
||||
|
||||
<para>
|
||||
Returns the ID of the producer that most recently sent a MIDI event to
|
||||
@ -105,7 +105,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_settimeout">
|
||||
<title>void BMidiLocalConsumer::SetTimeout(bigtime_t when, void *data)</title>
|
||||
<title>void SetTimeout(bigtime_t when, void *data)</title>
|
||||
|
||||
<para>
|
||||
Requests that the Timeout() hook will be called at some point
|
||||
@ -146,7 +146,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_timeout">
|
||||
<title>virtual void BMidiLocalConsumer::Timeout(void *data)</title>
|
||||
<title>virtual void Timeout(void *data)</title>
|
||||
|
||||
<para>
|
||||
Hook function that is called per your own request.
|
||||
@ -158,7 +158,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_data">
|
||||
<title>virtual void BMidiLocalConsumer::Data(
|
||||
<title>virtual void Data(
|
||||
uchar *data, size_t length, bool atomic, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -205,7 +205,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_noteoff">
|
||||
<title>virtual void BMidiLocalConsumer::NoteOff(
|
||||
<title>virtual void NoteOff(
|
||||
uchar channel, uchar note, uchar velocity, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -218,7 +218,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_noteon">
|
||||
<title>virtual void BMidiLocalConsumer::NoteOn(
|
||||
<title>virtual void NoteOn(
|
||||
uchar channel, uchar note, uchar velocity, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -231,7 +231,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_keypressure">
|
||||
<title>virtual void BMidiLocalConsumer::KeyPressure(
|
||||
<title>virtual void KeyPressure(
|
||||
uchar channel, uchar note, uchar pressure, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -244,7 +244,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_controlchange">
|
||||
<title>virtual void BMidiLocalConsumer::ControlChange(
|
||||
<title>virtual void ControlChange(
|
||||
uchar channel, uchar controlNumber, uchar controlValue, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -257,7 +257,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_programchange">
|
||||
<title>virtual void BMidiLocalConsumer::ProgramChange(
|
||||
<title>virtual void ProgramChange(
|
||||
uchar channel, uchar programNumber, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -270,7 +270,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_channelpressure">
|
||||
<title>virtual void BMidiLocalConsumer::ChannelPressure(
|
||||
<title>virtual void ChannelPressure(
|
||||
uchar channel, uchar pressure, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -283,7 +283,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_pitchbend">
|
||||
<title>virtual void BMidiLocalConsumer::PitchBend(
|
||||
<title>virtual void PitchBend(
|
||||
uchar channel, uchar lsb, uchar msb, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -296,9 +296,8 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_systemexclusive">
|
||||
<title>virtual void BMidiLocalConsumer::SystemExclusive(
|
||||
void* data, size_t length, bigtime_t time)
|
||||
</title>
|
||||
<title>virtual void SystemExclusive(
|
||||
void* data, size_t length, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
Invoked when a System Exclusive event is received
|
||||
@ -320,7 +319,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_systemcommon">
|
||||
<title>virtual void BMidiLocalConsumer::SystemCommon(
|
||||
<title>virtual void SystemCommon(
|
||||
uchar status, uchar data1, uchar data2, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -337,7 +336,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_systemrealtime">
|
||||
<title>virtual void BMidiLocalConsumer::SystemRealTime(
|
||||
<title>virtual void SystemRealTime(
|
||||
uchar status, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
@ -350,7 +349,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_tempochange">
|
||||
<title>virtual void BMidiLocalConsumer::TempoChange(int32 beatsPerMinute, bigtime_t time)</title>
|
||||
<title>virtual void TempoChange(int32 beatsPerMinute, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
Invoked when a Tempo Change event is received
|
||||
@ -362,7 +361,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalconsumer_allnotesoff">
|
||||
<title>virtual void BMidiLocalConsumer::AllNotesOff(bool justChannel, bigtime_t time)</title>
|
||||
<title>virtual void AllNotesOff(bool justChannel, bigtime_t time)</title>
|
||||
|
||||
<para>
|
||||
Not used
|
||||
|
@ -34,7 +34,7 @@
|
||||
</para>
|
||||
|
||||
<sect3 id="bmidilocalproducer_bmidilocalproducer">
|
||||
<title>BMidiLocalProducer::BMidiLocalProducer(const char *name = NULL)</title>
|
||||
<title>BMidiLocalProducer(const char *name = NULL)</title>
|
||||
|
||||
<para>
|
||||
Creates a new local producer endpoint.
|
||||
@ -70,7 +70,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_connected">
|
||||
<title>virtual void BMidiLocalProducer::Connected(BMidiConsumer *cons)</title>
|
||||
<title>virtual void Connected(BMidiConsumer *cons)</title>
|
||||
|
||||
<para>
|
||||
Invoked when a new consumer is connected to this producer
|
||||
@ -100,7 +100,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_disconnected">
|
||||
<title>virtual void BMidiLocalProducer::Disconnected(BMidiConsumer *cons)</title>
|
||||
<title>virtual void Disconnected(BMidiConsumer *cons)</title>
|
||||
|
||||
<para>
|
||||
Invoked when a consumer is disconnected from this producer.
|
||||
@ -112,8 +112,8 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraydata">
|
||||
<title>void BMidiLocalProducer::SprayData(
|
||||
void *data, size_t length, bool atomic = false, bigtime_t time = 0) const </title>
|
||||
<title>void SprayData(
|
||||
void *data, size_t length, bool atomic = false, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
Sends raw MIDI data downstream to all connected consumers
|
||||
@ -149,7 +149,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraynoteoff">
|
||||
<title>void BMidiLocalProducer::SprayNoteOff(
|
||||
<title>void SprayNoteOff(
|
||||
uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
@ -162,7 +162,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraynoteon">
|
||||
<title>void BMidiLocalProducer::SprayNoteOn(
|
||||
<title>void SprayNoteOn(
|
||||
uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
@ -175,7 +175,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidIlocalproducer_spraykeypressure">
|
||||
<title>void BMidiLocalProducer::SprayKeyPressure(
|
||||
<title>void SprayKeyPressure(
|
||||
uchar channel, uchar note, uchar pressure, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
@ -189,9 +189,9 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraycontrolchange">
|
||||
<title>void BMidiLocalProducer::SprayControlChange(
|
||||
<title>void SprayControlChange(
|
||||
uchar channel, uchar controlNumber, uchar controlValue,
|
||||
bigtime_t time = 0) const </title>
|
||||
bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
Sends a Controller Change event to all connected consumers.
|
||||
@ -204,9 +204,9 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_sprayprogramchange">
|
||||
<title>BMidiLocalProducer::SprayProgramChange(
|
||||
uchar channel, uchar programNumber, bigtime_t time = 0) const </title>
|
||||
|
||||
<title>void SprayProgramChange(
|
||||
uchar channel, uchar programNumber, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
Sends a Program Change event to all connected consumers
|
||||
</para>
|
||||
@ -217,8 +217,8 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraychannelpressure">
|
||||
<title>void BMidiLocalProducer::SprayChannelPressure(
|
||||
uchar channel, uchar pressure, bigtime_t time = 0) const </title>
|
||||
<title>void SprayChannelPressure(
|
||||
uchar channel, uchar pressure, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
Sends a Channel Pressure event to all connected consumers
|
||||
@ -230,8 +230,8 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraypitchbend">
|
||||
<title>void BMidiLocalProducer::SprayPitchBend(
|
||||
uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const </title>
|
||||
<title>void SprayPitchBend(
|
||||
uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
Sends a Pitch Bend event to all connected consumers
|
||||
@ -243,9 +243,8 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraysystemexclusive">
|
||||
<title>
|
||||
void BMidiLocalProducer::SpraySystemExclusive(
|
||||
void *data, size_t length, bigtime_t time = 0) const </title>
|
||||
<title>void SpraySystemExclusive(
|
||||
void *data, size_t length, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
Sends a System Exclusive event to all connected consumers
|
||||
@ -264,7 +263,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraysystemcommon">
|
||||
<title>void BMidiLocalProducer::SpraySystemCommon(
|
||||
<title>void SpraySystemCommon(
|
||||
uchar status, uchar data1, uchar data2, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
@ -322,7 +321,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraysystemrealtime">
|
||||
<title>void BMidiLocalProducer::SpraySystemRealTime(
|
||||
<title>void SpraySystemRealTime(
|
||||
uchar status, bigtime_t time = 0) const</title>
|
||||
|
||||
<para>
|
||||
@ -383,8 +382,8 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidilocalproducer_spraytempochange">
|
||||
<title>void BMidiLocalProducer::SprayTempoChange(
|
||||
int32 bpm, bigtime_t time = 0) const </title>
|
||||
<title>void SprayTempoChange(
|
||||
int32 beatsPerMinute, bigtime_t time = 0) const</title>
|
||||
<para>
|
||||
Sends a Tempo Change event to the connected consumers.
|
||||
</para>
|
||||
|
@ -20,7 +20,7 @@
|
||||
</para>
|
||||
|
||||
<sect3 id="bmidiproducer_connect">
|
||||
<title>status_t BMidiProducer::Connect(BMidiConsumer *cons)</title>
|
||||
<title>status_t Connect(BMidiConsumer *cons)</title>
|
||||
|
||||
<para>
|
||||
Connects a consumer to this producer
|
||||
@ -45,7 +45,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiproducer_disconnect">
|
||||
<title>status_t BMidiProducer::Disconnect(BMidiConsumer *cons)</title>
|
||||
<title>status_t Disconnect(BMidiConsumer *cons)</title>
|
||||
|
||||
<para>
|
||||
Disconnects a consumer from this producer
|
||||
@ -67,7 +67,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiproducer_isconnected">
|
||||
<title>bool BMidiProducer::IsConnected(BMidiConsumer *cons) const</title>
|
||||
<title>bool IsConnected(BMidiConsumer *cons) const</title>
|
||||
|
||||
<para>
|
||||
Determines whether a consumer is connected to this producer
|
||||
@ -80,7 +80,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiproducer_connections">
|
||||
<title>BList *BMidiProducer::Connections() const</title>
|
||||
<title>BList *Connections() const</title>
|
||||
|
||||
<para>
|
||||
Returns a list with all connected consumers
|
||||
|
@ -26,12 +26,12 @@
|
||||
<para>
|
||||
You can call BMidiRoster's functions like this:
|
||||
<programlisting>
|
||||
producer = BMidiRoster::FindProducer(someID);
|
||||
producer = FindProducer(someID);
|
||||
</programlisting>
|
||||
|
||||
Or using the slightly more annoying:
|
||||
<programlisting>
|
||||
BMidiRoster* roster = BMidiRoster::MidiRoster();
|
||||
BMidiRoster *roster = MidiRoster();
|
||||
if (roster != NULL)
|
||||
{
|
||||
producer = roster->FindProducer(someID);
|
||||
@ -40,7 +40,7 @@
|
||||
</para>
|
||||
|
||||
<sect3 id="bmidiroster_nextendpoint">
|
||||
<title>BMidiEndpoint* BMidiRoster::NextEndpoint(int32* id)</title>
|
||||
<title>static BMidiEndpoint *NextEndpoint(int32 *id)</title>
|
||||
|
||||
<para>
|
||||
Returns the next endpoint from the roster
|
||||
@ -61,8 +61,8 @@
|
||||
Usage example:
|
||||
<programlisting>
|
||||
int32 id = 0;
|
||||
BMidiEndpoint* endp;
|
||||
while ((endp = BMidiRoster::NextEndpoint(&id)) != NULL)
|
||||
BMidiEndpoint *endp;
|
||||
while ((endp = NextEndpoint(&id)) != NULL)
|
||||
{
|
||||
...do something with endpoint ...
|
||||
endp->Release(); // don't forget!
|
||||
@ -78,7 +78,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_nextproducer">
|
||||
<title>BMidiProducer* BMidiRoster::NextProducer(int32* id)</title>
|
||||
<title>static BMidiProducer *NextProducer(int32 *id)</title>
|
||||
|
||||
<para>
|
||||
Returns the next producer from the roster
|
||||
@ -95,7 +95,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_nextconsumer">
|
||||
<title>BMidiConsumer* BMidiRoster::NextConsumer(int32* id)</title>
|
||||
<title>static BMidiConsumer *NextConsumer(int32 *id)</title>
|
||||
|
||||
<para>
|
||||
Returns the next consumer from the roster
|
||||
@ -112,7 +112,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_findendpoint">
|
||||
<title>BMidiEndpoint* BMidiRoster::FindEndpoint(
|
||||
<title>static BMidiEndpoint *FindEndpoint(
|
||||
int32 id, bool localOnly = false)</title>
|
||||
|
||||
<para>
|
||||
@ -133,17 +133,17 @@
|
||||
</para>
|
||||
|
||||
<para><programlisting>
|
||||
BMidiEndpoint* endp = ...;
|
||||
BMidiProducer* prod = NULL;
|
||||
BMidiConsumer* cons = NULL;
|
||||
BMidiEndpoint *endp = ...;
|
||||
BMidiProducer *prod = NULL;
|
||||
BMidiConsumer *cons = NULL;
|
||||
|
||||
if (endp->IsProducer())
|
||||
{
|
||||
prod = dynamic_cast<BMidiProducer*>(endp);
|
||||
prod = dynamic_cast<BMidiProducer *>(endp);
|
||||
}
|
||||
else if (endp->IsConsumer())
|
||||
{
|
||||
cons = dynamic_cast<BMidiConsumer*>(endp);
|
||||
cons = dynamic_cast<BMidiConsumer *>(endp);
|
||||
}
|
||||
</programlisting></para>
|
||||
|
||||
@ -152,7 +152,7 @@
|
||||
should always \link BMidiEndpoint::Release() Release() \endlink an endpoint
|
||||
when you are done with it:
|
||||
<programlisting>
|
||||
BMidiEndpoint* endp = BMidiRoster::FindEndpoint(someID);
|
||||
BMidiEndpoint *endp = FindEndpoint(someID);
|
||||
if (endp != NULL)
|
||||
{
|
||||
...do stuff with the endpoint...
|
||||
@ -163,7 +163,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_findproducer">
|
||||
<title>BMidiProducer* BMidiRoster::FindProducer(
|
||||
<title>static BMidiProducer *FindProducer(
|
||||
int32 id, bool localOnly = false)</title>
|
||||
|
||||
<para>
|
||||
@ -182,7 +182,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_findconsumer">
|
||||
<title>BMidiConsumer* BMidiRoster::FindConsumer(
|
||||
<title>static BMidiConsumer *FindConsumer(
|
||||
int32 id, bool localOnly = false)</title>
|
||||
|
||||
<para>
|
||||
@ -201,7 +201,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_startwatching">
|
||||
<title>void BMidiRoster::StartWatching(const BMessenger* msngr)</title>
|
||||
<title>static void StartWatching(const BMessenger *msngr)</title>
|
||||
|
||||
<para>
|
||||
Start receiving notifications from the Midi Roster
|
||||
@ -464,10 +464,10 @@
|
||||
void MyView::AttachedToWindow()
|
||||
{
|
||||
BMessenger msgr(this);
|
||||
BMidiRoster::StartWatching(&msgr);
|
||||
StartWatching(&msgr);
|
||||
}
|
||||
|
||||
void MyView::MessageReceived(BMessage* msg)
|
||||
void MyView::MessageReceived(BMessage *msg)
|
||||
{
|
||||
switch (msg->what)
|
||||
{
|
||||
@ -488,7 +488,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_stopwatching">
|
||||
<title>void BMidiRoster::StopWatching()</title>
|
||||
<title>static void StopWatching()</title>
|
||||
|
||||
<para>
|
||||
Stop receiving notifications from the Midi Roster
|
||||
@ -500,7 +500,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_register">
|
||||
<title>status_t BMidiRoster::Register(BMidiEndpoint* object)</title>
|
||||
<title>static status_t Register(BMidiEndpoint *endp)</title>
|
||||
|
||||
<para>
|
||||
Publishes an endpoint to other applications
|
||||
@ -513,7 +513,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_unregister">
|
||||
<title>status_t BMidiRoster::Unregister(BMidiEndpoint* object)</title>
|
||||
<title>static status_t Unregister(BMidiEndpoint *endp)</title>
|
||||
|
||||
<para>
|
||||
Hides an endpoint from other applications
|
||||
@ -526,7 +526,7 @@
|
||||
</sect3>
|
||||
|
||||
<sect3 id="bmidiroster_midiroster">
|
||||
<title>BMidiRoster* BMidiRoster::MidiRoster()</title>
|
||||
<title>static BMidiRoster *MidiRoster()</title>
|
||||
|
||||
<para>
|
||||
Returns a pointer to the only instance of BMidiRoster
|
||||
|
Loading…
x
Reference in New Issue
Block a user