.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "MusicBrainz::DiscID 3pm" .TH MusicBrainz::DiscID 3pm "2020-11-08" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" MusicBrainz::DiscID \- Perl interface for the MusicBrainz libdiscid library .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use MusicBrainz::DiscID; \& \& my $discid = MusicBrainz::DiscID\->new(); \& if ( $disc\->read() == 0 ) { \& print STDERR "Error: " . $discid\->error_msg() . "\en"; \& exit(1); \& } \& print "DiscID: " . $discid\->id() . "\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" MusicBrainz::DiscID is a class to calculate a MusicBrainz DiscID from an audio \s-1CD\s0 in the drive. The coding style is slightly different to the C interface to libdiscid, because it makes use of perl's Object Oriented functionality. .IP "\fBMusicBrainz::DiscID::default_device()\fR" 4 .IX Item "MusicBrainz::DiscID::default_device()" Returns a device string for the default device for this platform. .IP "MusicBrainz::DiscID::new( [$device] )" 4 .IX Item "MusicBrainz::DiscID::new( [$device] )" Construct a new DiscID object. .Sp As an optional argument the name of the device to read the \s-1ID\s0 from may be given. If you don't specify a device here you can later read the \s-1ID\s0 with the read method. .ie n .IP "$discid\->\fBerror_msg()\fR" 4 .el .IP "\f(CW$discid\fR\->\fBerror_msg()\fR" 4 .IX Item "$discid->error_msg()" Return a human-readable error message of the last error that occurred. .ie n .IP "$discid\->\fBfirst_track_num()\fR" 4 .el .IP "\f(CW$discid\fR\->\fBfirst_track_num()\fR" 4 .IX Item "$discid->first_track_num()" Return the number of the first track on this disc (usually 1). Returns undef if no \s-1ID\s0 was yet read. .ie n .IP "$discid\->\fBlast_track_num()\fR" 4 .el .IP "\f(CW$discid\fR\->\fBlast_track_num()\fR" 4 .IX Item "$discid->last_track_num()" Return the number of the last track on this disc. .ie n .IP "$discid\->\fBid()\fR" 4 .el .IP "\f(CW$discid\fR\->\fBid()\fR" 4 .IX Item "$discid->id()" Returns the DiscID as a string. Returns undef if no \s-1ID\s0 was yet read. .ie n .IP "$discid\->\fBlast_track_num()\fR" 4 .el .IP "\f(CW$discid\fR\->\fBlast_track_num()\fR" 4 .IX Item "$discid->last_track_num()" Return the number of the last track on this disc. Returns undef if no \s-1ID\s0 was yet read. .ie n .IP "$discid\->put( $first_track, $sectors, $offset1, $offset2, ... )" 4 .el .IP "\f(CW$discid\fR\->put( \f(CW$first_track\fR, \f(CW$sectors\fR, \f(CW$offset1\fR, \f(CW$offset2\fR, ... )" 4 .IX Item "$discid->put( $first_track, $sectors, $offset1, $offset2, ... )" This function may be used if the \s-1TOC\s0 has been read earlier and you want to calculate the disc \s-1ID\s0 afterwards, without accessing the disc drive. .ie n .IP "$discid\->read( [$device] )" 4 .el .IP "\f(CW$discid\fR\->read( [$device] )" 4 .IX Item "$discid->read( [$device] )" Read the disc \s-1ID\s0 from the given device. If no device is given the default device of the platform will be used. On error, this function returns false and sets the error message which you can access \f(CW$discid\fR\->\fBerror_msg()\fR. .ie n .IP "$discid\->\fBsectors()\fR" 4 .el .IP "\f(CW$discid\fR\->\fBsectors()\fR" 4 .IX Item "$discid->sectors()" Return the length of the disc in sectors. Returns undef if no \s-1ID\s0 was yet read. .ie n .IP "$discid\->\fBsubmission_url()\fR" 4 .el .IP "\f(CW$discid\fR\->\fBsubmission_url()\fR" 4 .IX Item "$discid->submission_url()" Returns a submission \s-1URL\s0 for the DiscID as a string. Returns undef if no \s-1ID\s0 was yet read. .ie n .IP "$discid\->track_length( $track_num )" 4 .el .IP "\f(CW$discid\fR\->track_length( \f(CW$track_num\fR )" 4 .IX Item "$discid->track_length( $track_num )" Return the length of a track in sectors. .ie n .IP "$discid\->track_offset( $track_num )" 4 .el .IP "\f(CW$discid\fR\->track_offset( \f(CW$track_num\fR )" 4 .IX Item "$discid->track_offset( $track_num )" Return the sector offset of a track. .SH "SEE ALSO" .IX Header "SEE ALSO" .SH "AUTHOR" .IX Header "AUTHOR" Nicholas J. Humfrey .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" The \s-1MIT\s0 License (\s-1MIT\s0) .PP Copyright (c) 2009\-2019 Nicholas J Humfrey .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\s0