Class TagLib::FileRef
In: lib/TagLib_doc.rb
Parent: Object
AudioProperties Properties Properties Properties Properties Properties Properties Properties File File File File File File File Tag Tag Tag Tag XiphComment File File File Frame AttachedPictureFrame CommentsFrame Header ByteVectorList ByteVector FrameList ItemListMap GenreMap FileRef FrameListMap StringList FieldListMap String Item Footer FrameFactory GeneralEncapsulatedObjectFrame Page PageHeader XingHeader Header MPC APE Vorbis ID3v1 FLAC ID3v2 Flac Speex Ogg MPEG WavPack TrueAudio TagLib dot/f_3.png

This class provides a simple abstraction for creating and handling files. .

FileRef exists to provide a minimal, generic and value-based wrapper around a File. It is lightweight and implicitly shared, and as such suitable for pass-by-value use. This hides some of the uglier details of TagLib::File and the non-generic portions of the concrete file implementations.This class is useful in a "simple usage" situation where it is desirable to be able to get and set some of the tag information that is similar across file types.Also note that it is probably a good idea to plug this into your mime type system rather than using the constructor that accepts a file name using the FileTypeResolver.FileTypeResolver addFileTypeResolver()

Methods

audioProperties   defaultFileExtensions   file   isNull   null?   save   tag  

Public Class methods

defaultFileExtensions()

Singleton methods

[Source]

# File lib/TagLib_doc.rb, line 80
      def self.defaultFileExtensions()
      end

Public Instance methods

audioProperties()

Returns the audio properties for this FileRef. If no audio properties were read then this will returns a null pointer.

[Source]

# File lib/TagLib_doc.rb, line 94
      def audioProperties()
      end
file()

Returns a pointer to the file represented by this handler class.As a general rule this call should be avoided since if you need to work with file objects directly, you are probably better served instantiating the File subclasses (i.e. MPEG::File) manually and working with their APIs.This handle exists to provide a minimal, generic and value-based wrapper around a File. Accessing the file directly generally indicates a moving away from this simplicity (and into things beyond the scope of FileRef).This pointer will become invalid when this FileRef and all copies pass out of scope.

[Source]

# File lib/TagLib_doc.rb, line 110
      def file()
      end
isNull()

Returns true if the file (and as such other pointers) are null.

[Source]

# File lib/TagLib_doc.rb, line 104
      def isNull()
      end
null?()

[Source]

# File lib/TagLib_doc.rb, line 82
      def null?()
      end
save()

Saves the file. Returns true on success.

[Source]

# File lib/TagLib_doc.rb, line 99
      def save()
      end
tag()

Returns a pointer to represented file's tag.This pointer will become invalid when this FileRef and all copies pass out of scope. File::tag()

[Source]

# File lib/TagLib_doc.rb, line 89
      def tag()
      end

[Validate]