nzilbb.labbcat (version 0.6-3)

getSoundFragments: Gets sound fragments from 'LaBB-CAT'.

Description

Gets sound fragments from 'LaBB-CAT'.

Usage

getSoundFragments(
  labbcat.url,
  ids,
  startOffsets,
  endOffsets,
  sampleRate = NULL,
  no.progress = FALSE,
  path = ""
)

Arguments

labbcat.url

URL to the LaBB-CAT instance

ids

The transcript ID (transcript name) of the sound recording, or a vector of transcript IDs.

startOffsets

The start time in seconds, or a vector of start times.

endOffsets

The end time in seconds, or a vector of end times.

sampleRate

Optional sample rate in Hz - if a positive integer, then the result is a mono file with the given sample rate.

no.progress

Optionally suppress the progress bar when multiple fragments are specified - TRUE for no progress bar.

path

Optional path to directory where the files should be saved.

Value

The name of the file, which is saved in the current directory, or a list of names of files, if multiple id's/start's/end's were specified

If a list of files is returned, they are in the order that they were returned by the server, which *should* be the order that they were specified in the id/start/end lists.

Examples

# NOT RUN {
## define the LaBB-CAT URL
labbcat.url <- "https://labbcat.canterbury.ac.nz/demo/"

## Get the 5 seconds starting from 10s after the beginning of a recording
wav.file <- getSoundFragments(labbcat.url, "AP2505_Nelson.eaf", 10.0, 15.0, path="samples")

## Get the 5 seconds starting from 10s as a mono 22kHz file
wav.file <- getSoundFragments(labbcat.url, "AP2505_Nelson.eaf", 10.0, 15.0, 22050)

## Load some search results previously exported from LaBB-CAT
results <- read.csv("results.csv", header=T)

## Get a list of fragments
wav.files <- getSoundFragments(labbcat.url, results$Transcript, results$Line, results$LineEnd)

## Get a list of fragments with no progress bar
wav.file <- getSoundFragments(
              labbcat.url, results$Transcript, results$Line, results$LineEnd, no.progress=TRUE)
# }