Component: DSPBufferRef (DSP)

Author	Matrix TSL
Version	1.0
Category	DSP

DSPBufferRef component

Reference and access to a specific DSP buffer inside another DSP component. Used for a DSP component input buffer.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	Prv_PutPropStr
- UINT	Idx
- UINT	Val
- VOID	Return

	Prv_PutConsole
- UINT	Idx
- ULONG	Val
- VOID	Return

	get
- UINT	Idx
[[File:]] -	Return

	put
- UINT	Idx
[[File:]] -	Val
- VOID	Return

	Prv_GetPropStr
- UINT	Idx
- UINT	Return

	Prv_GetConsole
- UINT	Idx
- ULONG	Return

	SetHandle
[[File:]] -	Handle
- VOID	Return

	IsPlaying
Checks to see if the last played track is still playing
[[File:]] -	Return

	GetReplyByte
Reads a single byte from the last reply. Each reply contains 4 bytes starting with the command code.
- BYTE	Index
Range: 0-3 / 0=Command, 1=Feedback, 2=Data MSB, 3=Data LSB
- BYTE	Return

	SkipTrack
Jump to the next or previous track
[[File:]] -	Direction
0=Next, 1=Previous
- VOID	Return

	PlayTrack
Plays track from the selected folder. MP3 & Advert folder track numbers should be 4 characters long e.g. 0001 any name.mp3, Other folder track numbers should be 3 characters long e.g. 001 Any name.mp3, Root the Track played in placement order.
- BYTE	Directory
0=Root, 1=Folder "01" - 99=Folder "99", 100=MP3, 101=Advert
- UINT	Track
Track number 1="001*.MP3" / "0001*.MP3", 100="100*.MP3" / "0100*.MP3"
- VOID	Return

	Initialise
Sets up the UART and does some housekeeping. Must be called before calling any of the other component macros.
- VOID	Return

	ReadAnalogAsInt
Reads one of the analogue components as an Integer value
- BYTE	Channel
0 = LDR, 1 = POT
[[File:]] -	Return

	RemapCharacter
Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters. The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.
- BYTE	RemapIdx
Remap Index, Range: 0 to (Remap Characters - 1)
- BYTE	SearchCharacter
Character to look for a replace
- BYTE	ReplacementCharacter
New character value to use in place of the search character.
- VOID	Return

	Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- VOID	Return

	SetLEDState
Sets the state of a single LED
- BYTE	Port
0 = PortA, 1 = PortB
- BYTE	LED
0 = LED0, 7 = LED7
- BYTE	State
- VOID	Return

	Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.
- VOID	Return

Property reference

	Properties
	Link To
	Subname
	Subhandle
	Buffer Size
	Buffer Type
	Console Handle
	Color
	Outline
	Text
	Orientation
	Connections
	Simulations