getSounds: Get Sounds from Pumilio

In pumilioR: Pumilio in R

Description

Function to get the data from sounds that match the search query.

Usage

	getSounds(pumilio_URL, SiteID=NA, ColID=NA, type="all", 
		credentials = NA, pumiliologin = NA)
	

Arguments

pumilio_URL	URL of the Pumilio installation, with trailing slash. For example: "http://server.com/pumilio/"
SiteID	ID of a valid site, obtained using getSites
ColID	ID of a valid collection, obtained using getCollections
type	type of query to run: "all" to get all sounds in the archive; "site" for the site specified with SiteID; "col" for the collection specified with ColID; "both" for sounds that match both the site specified with SiteID and the collection specified with ColID.
credentials	username and password, separated with a colon, for websites that require basic Apache webserver authentication
pumiliologin	username and password, separated with a colon, for Pumilio systems that require a valid user

Value

Returns a data frame with the sound data.

SoundID	ID of the soundfile in the database
ColID	ID of the collection in which this file is archived in
SiteID	ID of the site where this sound was recorded
OriginalFilename	filename of the soundfile
SoundName	filename of the soundfile, usually OriginalFilename without the extension
day	day part of the date when it was recorded
month	month part of the date when it was recorded
year	year part of the date when it was recorded
hour	hour part of the date when it was recorded
minutes	minutes part of the date when it was recorded
seconds	seconds part of the date when it was recorded
SamplingRate	sampling rate used to record the soundfile, in Hz
BitRate	bitrate of the file, in bits
Channels	number of channels
Duration	duration of the soundfile, in seconds
SoundFormat	format of the file
SensorID	ID of the sensor used to record the soundfile
Notes	notes of the soundfile
timestamp	date and time stamp when the soundfile was added to the archive
FileSize	file size of the soundfile, in bytes
FilePath	URL of the soundfile
AudioPreviewFormat	format of the preview file, usually mp3
AudioPreviewFilename	filename of the preview file
AudioPreviewFilePath	URL of the preview file

Examples

	## Not run: 
		sounds <- getSounds(pumilio_URL="http://pumilio.coquipr.com/pumilio/",
			SiteID=111, type="site")
		sounds[1,]
	
## End(Not run)

pumilioR documentation built on May 2, 2019, 3:36 p.m.